diff --git a/README.md b/README.md index b33c7e0..2c496a1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# PP-P2P-Parser +

PP-P2P-Parser

-## Code Status - -![](https://github.com/ChrisRBe/PP-P2P-Parser/workflows/Integration/badge.svg?branch=master) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![Maintainability](https://api.codeclimate.com/v1/badges/f3bad303efd4200ebee2/maintainability)](https://codeclimate.com/github/ChrisRBe/PP-P2P-Parser/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/f3bad303efd4200ebee2/test_coverage)](https://codeclimate.com/github/ChrisRBe/PP-P2P-Parser/test_coverage) -[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) -[![Bors enabled](https://bors.tech/images/badge_small.svg)](https://app.bors.tech/repositories/37041) +

+Action Status +Test Coverage +Maintainability +pre-commit: enabled +Code style: black +Bors enabled +

## Introduction @@ -18,7 +18,7 @@ Input format needs to be a csv file as well! ## Usage -``` +```text parse-account-statements.py --help usage: An application to read account statement files from different peer to peer lending sites, e.g. Mintos.com and creates @@ -57,22 +57,24 @@ optional arguments: --debug enables debug level logging if set ``` -Example +### Example -``` +```shell ./parse-account-statements.py --type mintos src/test/testdata/mintos.csv ``` -> ⚠ If you are using the --aggregate=monthly option, please note that this application aggregates always on the -> last day of the month. This can lead to import issues in Portfolio Performance when importing data for -> the current month. -> -> E.g. import date is the 15th of a July, the account statement contains data with a date of 31st of July. -> -> Account activity for a "future date" will be ignored/ not imported by Portfolio Performance. -> -> Please note, that this behaviour on this application side is intentional to avoid importing account activity multiple -> times in Portfolio Performance. +## ⚠ Information + +⚠ If you are using the --aggregate=monthly option, please note that this aggregates account activities +always on then last day of the month. This can lead to import issues in Portfolio Performance when importing +data for the current month. + +E.g. import date is the 15th of a July, the account statement contains data with a date of 31st of July. + +Account activity for a "future date" will be ignored/ not imported by Portfolio Performance. + +Please note, that this behaviour on application side is intentional to avoid importing account activity +multiple times in Portfolio Performance. ## Currently supported formats @@ -97,7 +99,7 @@ The content directly reflects the format of the source account statement files. Example: -``` +```yaml --- type_regex: !!map deposit: "(Deposits)|(^Incoming client.*)|(^Incoming currency exchange.*)|(^Affiliate partner bonus$)" @@ -125,16 +127,19 @@ CSV file format compatible with Performance Portfolio (German language setting). To use this application the following dependencies need to be installed: -* Python 3.6+ (unit test are run against Python 3.6, 3.7, 3.8, 3.9) -* PyYaml +* Python 3.7+ (unit test are run against Python 3.7, 3.8, 3.9, 3.10) +* virtualenv +* pipenv Installation of Python dependencies can be handled in two ways: * Install dependencies via `pip install -r requirements.txt` -* Create a virtual environment using pipenv +* Create a virtual environment using pipenv (**preferred way**) - pipenv install - pipenv shell + ```shell + pipenv install + pipenv shell + ``` ## Legal diff --git a/requirements.txt b/requirements.txt index cc00e36..108cbb7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,43 +1,43 @@ -appdirs==1.4.4 astroid==2.11.2 atomicwrites==1.4.0 attrs==21.4.0 -black==21.4b2 +black==22.3.0 certifi==2021.10.8 cfgv==3.3.1 -chardet==4.0.0 +charset-normalizer==2.0.12 click==8.1.2 codacy-coverage==1.3.11 colorama==0.4.4 -coverage==5.5 +coverage==6.3.2 +dill==0.3.4 distlib==0.3.4 filelock==3.6.0 -flake8==3.9.1 +flake8==4.0.1 identify==2.4.12 idna==3.3 iniconfig==1.1.1 isort==5.10.1 lazy-object-proxy==1.7.1 -mccabe==0.7.0 +mccabe==0.6.1 mypy-extensions==0.4.3 nodeenv==1.6.0 packaging==21.3 pathspec==0.9.0 +platformdirs==2.5.1 pluggy==1.0.0 -pre-commit==2.12.1 +pre-commit==2.18.1 py==1.11.0 pycodestyle==2.8.0 pyflakes==2.4.0 -pylint==2.8.2 +pylint==2.13.4 pyparsing==3.0.7 -pytest==6.2.3 -pytest-cov==2.11.1 -PyYAML==5.4.1 -regex==2022.3.15 +pytest==7.1.1 +pytest-cov==3.0.0 +PyYAML==6.0 requests==2.27.1 six==1.16.0 toml==0.10.2 -typed-ast==1.5.2 +tomli==2.0.1 typing-extensions==4.1.1 urllib3==1.26.9 virtualenv==20.14.0