Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: 2025 RustInFinance
# SPDX-License-Identifier: BSD-3-Clause

# These are supported funding model platforms

github: [RustInFinance]
3 changes: 3 additions & 0 deletions .github/workflows/building.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: 2022-2025 RustInFinance
# SPDX-License-Identifier: BSD-3-Clause

on: [pull_request]

name: Continuous integration
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/coverage.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: 2024-2025 RustInFinance
# SPDX-License-Identifier: BSD-3-Clause

name: Code Coverage

on: [pull_request]
Expand Down
20 changes: 20 additions & 0 deletions .github/workflows/reuse-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
#
# SPDX-License-Identifier: CC0-1.0
Comment on lines +1 to +3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't update this header.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't want to modify the external file, only changed it in our files.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks kinda internal, but ok.

---
name: REUSE Compliance Check

on: [push, pull_request]

permissions:
contents: read

jobs:
reuse-compliance-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: REUSE Compliance Check
uses: fsfe/reuse-action@v5
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# SPDX-FileCopyrightText: 2023-2025 RustInFinance
# SPDX-License-Identifier: BSD-3-Clause

target
9 changes: 9 additions & 0 deletions .reuse/templates/no_newline.jinja2
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
{% for contributor_line in contributor_lines %}
SPDX-FileContributor: {{ contributor_line }}
{% endfor %}
{% for expression in spdx_expressions %}
SPDX-License-Identifier: {{ expression }}
{% endfor %}
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# SPDX-FileCopyrightText: 2022-2025 RustInFinance
# SPDX-License-Identifier: BSD-3-Clause

[package]
name = "etradeTaxReturnHelper"
version = "0.7.4"
Expand Down
29 changes: 0 additions & 29 deletions LICENCE

This file was deleted.

11 changes: 11 additions & 0 deletions LICENSES/BSD-3-Clause.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Copyright (c) <year> <owner>.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
121 changes: 121 additions & 0 deletions LICENSES/CC0-1.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
3 changes: 3 additions & 0 deletions LICENSES/LicenseRef-ETrade-MorganStanley.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
E*TRADE from Morgan Stanley is a business of Morgan Stanley. Morgan Stanley Smith Barney LLC does not render advice on tax and tax accounting matters to clients. Clients should speak with their
own tax advisors regarding their personal tax circumstances or specific advice regarding tax matters
© 2022 Morgan Stanley Smith Barney LLC. Member SIPC. CRC 5243530 10/22 CS 372456-2484693 12/22
10 changes: 10 additions & 0 deletions LICENSES/LicenseRef-Private-Data.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
LicenseRef-Private-Data

Copyright (c) 2025 RustInFinance

Permission is granted to repository contributors and maintainers to use these data files solely for local development, testing, and evaluation within this repository.

Redistribution, public disclosure, or reuse of these data files outside this repository is not permitted without prior written permission from the copyright holder. All rights reserved.

THE DATA FILES ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE DATA FILES OR THE USE OR OTHER DEALINGS IN THE DATA FILES.

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2022-2025 RustInFinance
SPDX-License-Identifier: BSD-3-Clause
-->

# etradeTaxReturnHelper
Project that parse e-trade and revolut account statements and Gain and Losses documents in order to compute total gross gain and tax paid in US that are needed for tax return forms out of US.

Expand Down
26 changes: 26 additions & 0 deletions REUSE.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
version = 1

[[annotations]]
path = ["data/HowToReadETfromMSStatement.pdf"]
precedence = "aggregate"
SPDX-FileCopyrightText = "© 2022 Morgan Stanley Smith Barney LLC. Member SIPC."
SPDX-License-Identifier = "LicenseRef-ETrade-MorganStanley"

[[annotations]]
path=[
"Cargo.lock",
"assets/etradetaxreturnhelper-640x480.gif",
]
SPDX-FileCopyrightText = "2025 RustInFinance"
SPDX-License-Identifier = "BSD-3-Clause"

[[annotations]]
path = [
"data/G&L_Collapsed.xlsx",
"data/G&L_Expanded.xlsx",
"data/G&L_Expanded_polish.xlsx",
"data/ecb_example_response.xml",
"revolut_data/*.csv",
]
SPDX-FileCopyrightText = "2025 RustInFinance"
SPDX-License-Identifier = "LicenseRef-Private-Data"
5 changes: 5 additions & 0 deletions src/bin/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
SPDX-FileCopyrightText: 2024-2025 RustInFinance
SPDX-License-Identifier: BSD-3-Clause
-->

### Usage
1. Get JSON data with exchange rates. For example USD to PLN throughput year 2024:
```bash
Expand Down
3 changes: 3 additions & 0 deletions src/bin/gen_exchange_rates.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2024-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use clap::{App, Arg};
use serde::Deserialize;
use std::collections::HashMap;
Expand Down
3 changes: 3 additions & 0 deletions src/csvparser.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2023-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use nom::{
bytes::complete::tag, bytes::complete::take, error::Error, multi::many_m_n,
number::complete::double, sequence::tuple,
Expand Down Expand Up @@ -443,7 +446,7 @@
let mut incomes: Vec<crate::Currency> = vec![];
let mut taxes: Vec<crate::Currency> = vec![];

const DELIMITER: u8 = b';';

Check warning on line 449 in src/csvparser.rs

View workflow job for this annotation

GitHub Actions / coverage

variable does not need to be mutable

//let mut rdr = csv::Reader::from_path(csvtoparse).map_err(|_| "Error: opening CSV")?;
let mut rdr = csv::ReaderBuilder::new()
Expand Down Expand Up @@ -725,7 +728,7 @@

let df =
DataFrame::new(vec![description, moneyin]).map_err(|_| "Error creating DataFrame")?;

Check warning on line 731 in src/csvparser.rs

View workflow job for this annotation

GitHub Actions / coverage

function `test_parse_date_helper` is never used
assert_eq!(
parse_incomes(&df, "Total Amount"),
Ok(vec![
Expand Down
3 changes: 3 additions & 0 deletions src/de.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use regex::Regex;

pub struct DE {}
Expand Down
3 changes: 3 additions & 0 deletions src/ecb.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2024-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use chrono;
use roxmltree;

Expand Down
3 changes: 3 additions & 0 deletions src/gui.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2023-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

#![cfg(feature = "gui")]

pub use crate::logging::ResultExt;
Expand All @@ -21,7 +24,7 @@
use std::rc::Rc;

#[derive(Copy, Clone)]
pub enum Message {

Check warning on line 27 in src/gui.rs

View workflow job for this annotation

GitHub Actions / coverage

enum `Message` is never used
ChoiceChanged,
Changed,
Execute,
Expand All @@ -32,7 +35,7 @@
}

/// Dummy method for running diagnostic
fn feed_input(browser: &mut MultiBrowser) {

Check warning on line 38 in src/gui.rs

View workflow job for this annotation

GitHub Actions / coverage

function `feed_input` is never used
let docs = [
"/home/jczaja/e-trade-tax-return-pl-helper/etrade_data/Brokerage Statement - XXXX0848 - 202202.pdf",
"/home/jczaja/e-trade-tax-return-pl-helper/etrade_data/Brokerage Statement - XXXX0848 - 202203.pdf",
Expand Down Expand Up @@ -332,15 +335,15 @@

wind.handle(move |wind, ev| {
let mut dnd = false;
let mut released = false;

Check warning on line 338 in src/gui.rs

View workflow job for this annotation

GitHub Actions / coverage

variable `released` is assigned to, but never used
match ev {
Event::DndEnter => {
dnd = true;

Check warning on line 341 in src/gui.rs

View workflow job for this annotation

GitHub Actions / coverage

value assigned to `dnd` is never read
true
}
Event::DndDrag => true,
Event::DndRelease => {
released = true;

Check warning on line 346 in src/gui.rs

View workflow job for this annotation

GitHub Actions / coverage

value assigned to `released` is never read
true
}
Event::Paste => {
Expand Down
13 changes: 7 additions & 6 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

mod csvparser;
mod ecb;
mod logging;
Expand Down Expand Up @@ -554,13 +557,11 @@ mod tests {

#[test]
fn test_validate_file_names_no_extension() {
let files = vec![String::from("LICENCE")];
let fpath = ".git/description";
let files = vec![String::from(fpath)];

let result = validate_file_names(&files);
assert_eq!(
result.err(),
Some(String::from("File has no extension: LICENCE"))
);
let err = validate_file_names(&files).unwrap_err();
assert_eq!(err, format!("File has no extension: {}", fpath));
}

#[test]
Expand Down
3 changes: 3 additions & 0 deletions src/logging.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use std::fmt;

// Let's extend Result with logging
Expand Down
3 changes: 3 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use clap::{App, AppSettings, Arg};
use std::env;

Expand Down
3 changes: 3 additions & 0 deletions src/nbp.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2024-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use std::collections::HashMap;

use etradeTaxReturnHelper::Exchange;
Expand Down
3 changes: 3 additions & 0 deletions src/pdfparser.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use pdf::file::File;
use pdf::object::PageRc;
use pdf::primitive::Primitive;
Expand Down
3 changes: 3 additions & 0 deletions src/pl.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use chrono::Datelike;
use serde::{Deserialize, Serialize};

Expand Down
3 changes: 3 additions & 0 deletions src/transactions.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

use chrono;
use chrono::Datelike;

Expand Down
3 changes: 3 additions & 0 deletions src/us.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// SPDX-FileCopyrightText: 2022-2025 RustInFinance
// SPDX-License-Identifier: BSD-3-Clause

pub struct US {}
impl etradeTaxReturnHelper::Residency for US {
fn get_exchange_rates(
Expand Down
Loading
Loading