1
- # PP-P2P-Parser
1
+ < h1 align = " center " > PP-P2P-Parser</ h1 >
2
2
3
- ## Code Status
4
-
5
- ![ ] ( https://github .com/ChrisRBe/PP-P2P-Parser/workflows/Integration/badge.svg?branch=master )
6
- [ ![ Code style: black ] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github. com/psf/black )
7
- [ ![ Maintainability ] ( https://api.codeclimate. com/v1/badges/f3bad303efd4200ebee2/maintainability )] ( https://codeclimate.com/github/ChrisRBe/PP-P2P-Parser/maintainability )
8
- [ ![ Test Coverage ] ( https://api.codeclimate. com/v1/badges/f3bad303efd4200ebee2/test_coverage )] ( https://codeclimate.com/github/ChrisRBe/PP-P2P-Parser/test_coverage )
9
- [ ![ pre-commit ] ( https://img.shields.io/badge/pre--commit- enabled-brightgreen?logo=pre-commit&logoColor=white )] ( https://github.com/pre-commit/pre-commit )
10
- [ ![ Bors enabled ] ( https://bors.tech/images/badge_small.svg )] ( https://app.bors.tech/repositories/37041 )
3
+ < p align = " center " >
4
+ < a href = " https://github.com/ChrisRBe/PP-P2P-Parser/actions " >< img alt = " Action Status " src = " https://github.com/ChrisRBe/PP-P2P-Parser/workflows/Integration/badge.svg?branch=master " ></ a >
5
+ < a href = " https://codeclimate .com/github/ ChrisRBe/PP-P2P-Parser/test_coverage " >< img alt = " Test Coverage " src = " https://api.codeclimate.com/v1/badges/f3bad303efd4200ebee2/test_coverage " /></ a >
6
+ < a href = " https://codeclimate.com/github/ChrisRBe/PP-P2P-Parser/maintainability " >< img alt = " Maintainability " src = " https://api.codeclimate. com/v1/badges/f3bad303efd4200ebee2/maintainability " /></ a >
7
+ < a href = " https://github. com/pre-commit/pre-commit " >< img alt = " pre-commit: enabled " src = " https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white " style = " max-width : 100 % ; " ></ a >
8
+ < a href = " https://github. com/psf/black " >< img alt = " Code style: black " src = " https://img.shields.io/badge/code%20style-black-000000.svg " ></ a >
9
+ < a href = " https://app.bors.tech/repositories/37041 " >< img alt = " Bors enabled" src = " https://bors.tech/images/badge_small.svg " ></ a >
10
+ </ p >
11
11
12
12
## Introduction
13
13
@@ -18,7 +18,7 @@ Input format needs to be a csv file as well!
18
18
19
19
## Usage
20
20
21
- ```
21
+ ``` text
22
22
parse-account-statements.py --help
23
23
usage:
24
24
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:
57
57
--debug enables debug level logging if set
58
58
```
59
59
60
- Example
60
+ ### Example
61
61
62
- ```
62
+ ``` shell
63
63
./parse-account-statements.py --type mintos src/test/testdata/mintos.csv
64
64
```
65
65
66
- > ⚠ ; If you are using the --aggregate=monthly option, please note that this application aggregates always on the
67
- > last day of the month. This can lead to import issues in Portfolio Performance when importing data for
68
- > the current month.
69
- >
70
- > E.g. import date is the 15th of a July, the account statement contains data with a date of 31st of July.
71
- >
72
- > Account activity for a "future date" will be ignored/ not imported by Portfolio Performance.
73
- >
74
- > Please note, that this behaviour on this application side is intentional to avoid importing account activity multiple
75
- > times in Portfolio Performance.
66
+ ## ⚠ ; Information
67
+
68
+ ⚠ ; If you are using the --aggregate=monthly option, please note that this aggregates account activities
69
+ always on then last day of the month. This can lead to import issues in Portfolio Performance when importing
70
+ data for the current month.
71
+
72
+ E.g. import date is the 15th of a July, the account statement contains data with a date of 31st of July.
73
+
74
+ Account activity for a "future date" will be ignored/ not imported by Portfolio Performance.
75
+
76
+ Please note, that this behaviour on application side is intentional to avoid importing account activity
77
+ multiple times in Portfolio Performance.
76
78
77
79
## Currently supported formats
78
80
@@ -97,7 +99,7 @@ The content directly reflects the format of the source account statement files.
97
99
98
100
Example:
99
101
100
- ```
102
+ ``` yaml
101
103
---
102
104
type_regex : !!map
103
105
deposit : " (Deposits)|(^Incoming client.*)|(^Incoming currency exchange.*)|(^Affiliate partner bonus$)"
@@ -125,16 +127,19 @@ CSV file format compatible with Performance Portfolio (German language setting).
125
127
126
128
To use this application the following dependencies need to be installed:
127
129
128
- * Python 3.6+ (unit test are run against Python 3.6, 3.7, 3.8, 3.9)
129
- * PyYaml
130
+ * Python 3.7+ (unit test are run against Python 3.7, 3.8, 3.9, 3.10)
131
+ * virtualenv
132
+ * pipenv
130
133
131
134
Installation of Python dependencies can be handled in two ways:
132
135
133
136
* Install dependencies via ` pip install -r requirements.txt `
134
- * Create a virtual environment using pipenv
137
+ * Create a virtual environment using pipenv ( ** preferred way ** )
135
138
136
- pipenv install
137
- pipenv shell
139
+ ``` shell
140
+ pipenv install
141
+ pipenv shell
142
+ ```
138
143
139
144
# # Legal
140
145
0 commit comments