ofxstatement-paypal-2 3.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
@@ -0,0 +1 @@
1
+ include README.md
@@ -0,0 +1,134 @@
1
+ Metadata-Version: 2.2
2
+ Name: ofxstatement-paypal-2
3
+ Version: 3.0.0
4
+ Summary: Plugin for ofxstatement that support conversion from Paypal csv to OFX
5
+ Home-page: https://github.com/Alfystar/ofxstatement-paypal.git
6
+ Author: Alfystar
7
+ Author-email: alfystar1701@gmail.com
8
+ License: Apache License 2.0
9
+ Keywords: ofx,ofxstatement,paypal
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Natural Language :: English
13
+ Classifier: Topic :: Office/Business :: Financial :: Accounting
14
+ Classifier: Topic :: Utilities
15
+ Classifier: Environment :: Console
16
+ Classifier: Operating System :: OS Independent
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: ofxstatement
20
+ Dynamic: author
21
+ Dynamic: author-email
22
+ Dynamic: classifier
23
+ Dynamic: description
24
+ Dynamic: description-content-type
25
+ Dynamic: home-page
26
+ Dynamic: keywords
27
+ Dynamic: license
28
+ Dynamic: requires-dist
29
+ Dynamic: summary
30
+
31
+ # ofxstatement-paypal
32
+
33
+ ### Paypal plugin for ofxstatement
34
+
35
+ This project provides a custom plugin for [ofxstatement](https://github.com/kedder/ofxstatement) for Paypal. It is based
36
+ on the work done by gerasiov (https://github.com/gerasiov/ofxstatement-paypal/).
37
+
38
+ `ofxstatement`_ is a tool to convert proprietary bank statement to OFX format, suitable for importing to GnuCash / Odoo. Plugin for ofxstatement parses a particular proprietary bank statement format and produces common data structure, that is then formatted into an OFX file.
39
+
40
+ Users of ofxstatement have developed several plugins for their banks. They are listed on main [`ofxstatement`](https://github.com/kedder/ofxstatement) site. If your bank is missing, you can develop your own plugin.
41
+
42
+ > This repository is a fork of the original project, afrter the original author did not respond to the pull request, we decided to create a new repository to maintain the project.
43
+
44
+ ## Installation
45
+
46
+ ### From PyPI repositories
47
+ ```
48
+ pip3 install ofxstatement-paypal-2
49
+ ```
50
+
51
+ ### From source
52
+ ```
53
+ git clone https://github.com/Alfystar/ofxstatement-paypal-2.git
54
+ cd ofxstatement-paypal
55
+ pip install build
56
+ python3 -m build --sdist --wheel
57
+ ```
58
+
59
+ ### Configuration
60
+
61
+ You have to configure some parameter in your local environment to allow the conversion.
62
+
63
+ To edit the config file, run this command:
64
+
65
+ ```bash
66
+ $ ofxstatement edit-config
67
+ ```
68
+ It's open a `vim` editor with current configuration.
69
+
70
+ Now add plug-in configuration, here is example with the default configuration:
71
+
72
+ ```ini
73
+ [Conf-Name]
74
+ plugin = paypal-convert
75
+ encoding = utf-8
76
+ dataformat = %%d/%%m/%%Y
77
+ default_account = Paypal Personal
78
+ ```
79
+
80
+ Now, base on your country, edit:
81
+
82
+ - `Conf-Name`: is a text string, you can name it as you wish. Is used to identify the configuration selected when you run `ofxstatement convert -t <Conf-Name> input.csv output.ofx`.
83
+ - `dataformat`: open your PayPal CSV and see your specific data-format.
84
+ - `%%d/%%m/%%Y` is Europe standard.
85
+ - `%%m/%%d/%%Y` is USA standard.
86
+ - etc...
87
+ - `default_account`: is text string, add on the beginning of the OFX file, help some program, like [Home Bank](http://homebank.free.fr/en/index.php), to detect witch account is used and help in import phase.
88
+
89
+ > Keep in mind you can have all the configuration you want, just add a new section with the same structure and change the name of the section.
90
+
91
+ ## Usage
92
+
93
+ From Paypal Web interface, download a CSV of `Bank statements` with the personalized report period you wish. (PayPal Login :arrow_right: History :arrow_right: Download :arrow_right: customized)
94
+
95
+ <img src="BankStatements.png" alt="Bank statements guide" style="zoom:50%;" />
96
+
97
+ Finally, open terminal in the directory where you download the report and type:
98
+
99
+ ```bash
100
+ $ ofxstatement convert -t <Conf-Name> input.csv output.ofx
101
+ ```
102
+
103
+ ### Add Alias
104
+ To simplify the use of the plugin, we strongly recommend adding an alias to your system (if in a Linux environment or on an emulated terminal) by adding the alias of this command to your *.bash_aliases*:
105
+ > **Note**: this alias use for confuguration name `paypal`, if you use another name, change it in the alias
106
+
107
+ ```bash
108
+ $ printf '\n# Paypal CSV convert to OFX format\nalias ofxPaypal="ofxstatement convert -t paypal"\n' >> ~/.bash_aliases
109
+ ```
110
+ After that, reload your terminal (close and then reopen) and the usage change to:
111
+ ```bash
112
+ $ ofxPaypal Paypal.csv Paypal.ofx
113
+ ```
114
+ **Note**: If after reload alias are not loading, go in your *.bashrc* and check if follow line are present, if not, add it on the end:
115
+ ```bash
116
+ # Alias definitions.
117
+ # You may want to put all your additions into a separate file like
118
+ # ~/.bash_aliases, instead of adding them here directly.
119
+ # See /usr/share/doc/bash-doc/examples in the bash-doc package.
120
+
121
+ if [ -f ~/.bash_aliases ]; then
122
+ . ~/.bash_aliases
123
+ fi
124
+ ```
125
+
126
+
127
+
128
+ ## How use OFX file after conversion
129
+
130
+ The `ofx` format stands for '*Open Financial Exchange*', it can be used to transfer your accounting records from one database to another.
131
+ Once you have the `ofx` file, you can use any program to manage your finances.
132
+ Among the many available, a non-exhaustive list of open source products is:
133
+
134
+ - [HomeBank](http://homebank.free.fr/en/index.php), continuously updated program, present everywhere except in smartphones, with many beautiful ideas and listening to the community. **100% compatibility**
@@ -0,0 +1,104 @@
1
+ # ofxstatement-paypal
2
+
3
+ ### Paypal plugin for ofxstatement
4
+
5
+ This project provides a custom plugin for [ofxstatement](https://github.com/kedder/ofxstatement) for Paypal. It is based
6
+ on the work done by gerasiov (https://github.com/gerasiov/ofxstatement-paypal/).
7
+
8
+ `ofxstatement`_ is a tool to convert proprietary bank statement to OFX format, suitable for importing to GnuCash / Odoo. Plugin for ofxstatement parses a particular proprietary bank statement format and produces common data structure, that is then formatted into an OFX file.
9
+
10
+ Users of ofxstatement have developed several plugins for their banks. They are listed on main [`ofxstatement`](https://github.com/kedder/ofxstatement) site. If your bank is missing, you can develop your own plugin.
11
+
12
+ > This repository is a fork of the original project, afrter the original author did not respond to the pull request, we decided to create a new repository to maintain the project.
13
+
14
+ ## Installation
15
+
16
+ ### From PyPI repositories
17
+ ```
18
+ pip3 install ofxstatement-paypal-2
19
+ ```
20
+
21
+ ### From source
22
+ ```
23
+ git clone https://github.com/Alfystar/ofxstatement-paypal-2.git
24
+ cd ofxstatement-paypal
25
+ pip install build
26
+ python3 -m build --sdist --wheel
27
+ ```
28
+
29
+ ### Configuration
30
+
31
+ You have to configure some parameter in your local environment to allow the conversion.
32
+
33
+ To edit the config file, run this command:
34
+
35
+ ```bash
36
+ $ ofxstatement edit-config
37
+ ```
38
+ It's open a `vim` editor with current configuration.
39
+
40
+ Now add plug-in configuration, here is example with the default configuration:
41
+
42
+ ```ini
43
+ [Conf-Name]
44
+ plugin = paypal-convert
45
+ encoding = utf-8
46
+ dataformat = %%d/%%m/%%Y
47
+ default_account = Paypal Personal
48
+ ```
49
+
50
+ Now, base on your country, edit:
51
+
52
+ - `Conf-Name`: is a text string, you can name it as you wish. Is used to identify the configuration selected when you run `ofxstatement convert -t <Conf-Name> input.csv output.ofx`.
53
+ - `dataformat`: open your PayPal CSV and see your specific data-format.
54
+ - `%%d/%%m/%%Y` is Europe standard.
55
+ - `%%m/%%d/%%Y` is USA standard.
56
+ - etc...
57
+ - `default_account`: is text string, add on the beginning of the OFX file, help some program, like [Home Bank](http://homebank.free.fr/en/index.php), to detect witch account is used and help in import phase.
58
+
59
+ > Keep in mind you can have all the configuration you want, just add a new section with the same structure and change the name of the section.
60
+
61
+ ## Usage
62
+
63
+ From Paypal Web interface, download a CSV of `Bank statements` with the personalized report period you wish. (PayPal Login :arrow_right: History :arrow_right: Download :arrow_right: customized)
64
+
65
+ <img src="BankStatements.png" alt="Bank statements guide" style="zoom:50%;" />
66
+
67
+ Finally, open terminal in the directory where you download the report and type:
68
+
69
+ ```bash
70
+ $ ofxstatement convert -t <Conf-Name> input.csv output.ofx
71
+ ```
72
+
73
+ ### Add Alias
74
+ To simplify the use of the plugin, we strongly recommend adding an alias to your system (if in a Linux environment or on an emulated terminal) by adding the alias of this command to your *.bash_aliases*:
75
+ > **Note**: this alias use for confuguration name `paypal`, if you use another name, change it in the alias
76
+
77
+ ```bash
78
+ $ printf '\n# Paypal CSV convert to OFX format\nalias ofxPaypal="ofxstatement convert -t paypal"\n' >> ~/.bash_aliases
79
+ ```
80
+ After that, reload your terminal (close and then reopen) and the usage change to:
81
+ ```bash
82
+ $ ofxPaypal Paypal.csv Paypal.ofx
83
+ ```
84
+ **Note**: If after reload alias are not loading, go in your *.bashrc* and check if follow line are present, if not, add it on the end:
85
+ ```bash
86
+ # Alias definitions.
87
+ # You may want to put all your additions into a separate file like
88
+ # ~/.bash_aliases, instead of adding them here directly.
89
+ # See /usr/share/doc/bash-doc/examples in the bash-doc package.
90
+
91
+ if [ -f ~/.bash_aliases ]; then
92
+ . ~/.bash_aliases
93
+ fi
94
+ ```
95
+
96
+
97
+
98
+ ## How use OFX file after conversion
99
+
100
+ The `ofx` format stands for '*Open Financial Exchange*', it can be used to transfer your accounting records from one database to another.
101
+ Once you have the `ofx` file, you can use any program to manage your finances.
102
+ Among the many available, a non-exhaustive list of open source products is:
103
+
104
+ - [HomeBank](http://homebank.free.fr/en/index.php), continuously updated program, present everywhere except in smartphones, with many beautiful ideas and listening to the community. **100% compatibility**
@@ -0,0 +1,15 @@
1
+ [bumpversion]
2
+ current_version = 3.0.0
3
+ commit = True
4
+ tag = True
5
+
6
+ [bumpversion:file:setup.py]
7
+
8
+ [metadata]
9
+ name = ofxstatement-paypal-2
10
+ long_description = file: README.md, LICENSE
11
+
12
+ [egg_info]
13
+ tag_build =
14
+ tag_date = 0
15
+
@@ -0,0 +1,34 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding: utf-8 -*-
3
+
4
+ from setuptools import setup, find_namespace_packages
5
+ from distutils.core import setup
6
+
7
+ setup(name='ofxstatement-paypal-2',
8
+ version='3.0.0',
9
+ author='Alfystar',
10
+ author_email='alfystar1701@gmail.com',
11
+ url='https://github.com/Alfystar/ofxstatement-paypal.git',
12
+ description=('Plugin for ofxstatement that support conversion from Paypal csv to OFX'),
13
+ long_description=open("README.md").read(),
14
+ long_description_content_type='text/markdown',
15
+ license='Apache License 2.0',
16
+ keywords=['ofx', 'ofxstatement', 'paypal'],
17
+ classifiers=[
18
+ 'Development Status :: 3 - Alpha',
19
+ 'Programming Language :: Python :: 3',
20
+ 'Natural Language :: English',
21
+ 'Topic :: Office/Business :: Financial :: Accounting',
22
+ 'Topic :: Utilities',
23
+ 'Environment :: Console',
24
+ 'Operating System :: OS Independent'
25
+ ],
26
+ packages=find_namespace_packages(where='src', include=['ofxstatement.plugins']),
27
+ package_dir={'': 'src'},
28
+ entry_points={
29
+ 'ofxstatement': ['paypal-convert = ofxstatement.plugins.paypal:PayPalPlugin']
30
+ },
31
+ install_requires=['ofxstatement'],
32
+ include_package_data=True,
33
+ zip_safe=True
34
+ )
@@ -0,0 +1 @@
1
+ # __import__('pkg_resources').declare_namespace(__name__)
@@ -0,0 +1,160 @@
1
+ import csv
2
+ import re
3
+ from datetime import datetime
4
+ from decimal import Decimal as D
5
+
6
+ from ofxstatement import statement
7
+ from ofxstatement.parser import CsvStatementParser
8
+ from ofxstatement.plugin import Plugin
9
+ from ofxstatement.statement import StatementLine, Currency
10
+
11
+
12
+ class PayPalPlugin(Plugin):
13
+
14
+ def get_parser(self, filename):
15
+ f = open(filename, 'r', encoding=self.settings.get("charset", "UTF-8"))
16
+ dataFormat = self.settings.get("dataformat")
17
+ if dataFormat is None:
18
+ dataFormat = "%%d/%%m/%%Y"
19
+ print("[Warning] No 'dataformat' found in 'config.ini', please add it with 'ofxstatement edit-config'")
20
+ print(f"[Warning] use USA default: '{dataFormat}'")
21
+ defaultAccount = self.settings.get("default_account")
22
+
23
+ parser = PayPalParser(f, dataFormat, defaultAccount)
24
+ # TODO: Sort file per date + time
25
+ return parser
26
+
27
+
28
+ class PayPalParser(CsvStatementParser):
29
+ date_format = None
30
+ # English name vesion of colums,
31
+ # From the point of view of the following code the position is important.
32
+ valid_header = [
33
+ u"Date",
34
+ u"Time",
35
+ u"Time Zone",
36
+ u"Description",
37
+ u"Currency",
38
+ u"Gross",
39
+ u"Fee",
40
+ u"Net",
41
+ u"Balance",
42
+ u"Transaction ID",
43
+ u"From Email Address",
44
+ u"Name",
45
+ u"Bank Name",
46
+ u"Bank Account",
47
+ u"Deliver And Handling Fees",
48
+ u"Sales Tax",
49
+ u"Invoice Number",
50
+ u"Reference Txn ID",
51
+ ]
52
+
53
+ unique_id_set = set()
54
+ filetype = None
55
+
56
+ def __init__(self, filePaypal, dataFormat: str, account: str) -> None:
57
+ super().__init__(filePaypal)
58
+ self.date_format = dataFormat
59
+ self.statement.account_id = account
60
+
61
+ def _setFileType(self):
62
+ self.filetype = "csv"
63
+
64
+ def parse(self):
65
+ """Main entry point for parsers
66
+
67
+ super() implementation will call to split_records and parse_record to
68
+ process the file.
69
+ """
70
+ self._setFileType()
71
+ stmt = super(PayPalParser, self).parse()
72
+ total_amount = sum(sl.amount for sl in stmt.lines)
73
+ stmt.end_balance = stmt.start_balance + total_amount
74
+ stmt.end_date = max(sl.date for sl in stmt.lines)
75
+ statement.recalculate_balance(stmt)
76
+ return stmt
77
+
78
+ def split_records(self):
79
+ """Return iterable object consisting of a line per transaction
80
+ """
81
+
82
+ reader = csv.reader(self.fin, delimiter=',')
83
+ next(reader, None)
84
+ return reader
85
+
86
+ def fix_amount(self, value):
87
+ dbt_re = r"(.*)(Dr)$"
88
+ cdt_re = r"Cr$"
89
+ dbt_subst = "-\\1"
90
+ cdt_subst = ""
91
+ result = re.sub(dbt_re, dbt_subst, value, 0)
92
+ result = re.sub(cdt_re, cdt_subst, result, 0)
93
+
94
+ # Consider "--" as a reversal entry
95
+ reversal_re = r"^--"
96
+ reversal_subst = ""
97
+ return re.sub(reversal_re, reversal_subst, result, 0)
98
+
99
+ def parse_record(self, line):
100
+ """Parse given transaction line and return StatementLine object
101
+ """
102
+
103
+ if self.filetype == "csv":
104
+ return self.parse_record_csv(line)
105
+ else:
106
+ return self.parse_record_pdf(line)
107
+
108
+ def parse_record_pdf(self, line):
109
+
110
+ return None
111
+
112
+ def parse_record_csv(self, line):
113
+ id_idx = self.valid_header.index("Transaction ID")
114
+ date_idx = self.valid_header.index("Date")
115
+ name_idx = self.valid_header.index("Name")
116
+ from_idx = self.valid_header.index("From Email Address")
117
+ amount_idx = self.valid_header.index("Gross")
118
+ currency_idx = self.valid_header.index("Currency")
119
+ balance_idx = self.valid_header.index("Balance")
120
+ refnum_idx = self.valid_header.index("Invoice Number")
121
+ bankName_idx = self.valid_header.index("Bank Name")
122
+ bankAccount_idx = self.valid_header.index("Bank Account")
123
+
124
+ if not self.statement.start_date:
125
+ self.statement.start_date = datetime.strptime(line[date_idx], self.date_format)
126
+ self.statement.start_balance = D(line[balance_idx].replace(',', '.')) - D(
127
+ line[amount_idx].replace(',', '.'))
128
+
129
+ # if not len(line[name_idx]) and not len(line[from_idx]) and not len(line[to_idx]):
130
+ # #Temporary trick to skip conversion transactions
131
+ # return None
132
+
133
+ smt_line = StatementLine()
134
+ smt_line.id = line[id_idx]
135
+ smt_line.date = datetime.strptime(line[date_idx], self.date_format)
136
+ smt_line.currency = Currency(line[currency_idx])
137
+ smt_line.amount = D(line[amount_idx].replace(',', '.').replace(u'\xa0', ''))
138
+
139
+ smt_line.refnum = line[refnum_idx]
140
+ if line[bankName_idx]: # Bank transaction
141
+ smt_line.trntype = "XFER"
142
+ else:
143
+ smt_line.trntype = "PAYMENT" if smt_line.amount < 0 else "DIRECTDEP"
144
+
145
+ # Build memo line
146
+ smt_line.memo = ""
147
+ memoLine = []
148
+ for column_name in [
149
+ "Name",
150
+ "From Email Address",
151
+ "Description",
152
+ "Invoice Number",
153
+ "Reference Txn ID",
154
+ "Bank Name",
155
+ ]:
156
+ memo_idx = self.valid_header.index(column_name)
157
+ if len(line[memo_idx]): # Save is someting are write on it
158
+ memoLine.append(f"{column_name}:{line[memo_idx]}")
159
+ smt_line.memo = "|".join(memoLine)
160
+ return smt_line
@@ -0,0 +1,134 @@
1
+ Metadata-Version: 2.2
2
+ Name: ofxstatement-paypal-2
3
+ Version: 3.0.0
4
+ Summary: Plugin for ofxstatement that support conversion from Paypal csv to OFX
5
+ Home-page: https://github.com/Alfystar/ofxstatement-paypal.git
6
+ Author: Alfystar
7
+ Author-email: alfystar1701@gmail.com
8
+ License: Apache License 2.0
9
+ Keywords: ofx,ofxstatement,paypal
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Natural Language :: English
13
+ Classifier: Topic :: Office/Business :: Financial :: Accounting
14
+ Classifier: Topic :: Utilities
15
+ Classifier: Environment :: Console
16
+ Classifier: Operating System :: OS Independent
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: ofxstatement
20
+ Dynamic: author
21
+ Dynamic: author-email
22
+ Dynamic: classifier
23
+ Dynamic: description
24
+ Dynamic: description-content-type
25
+ Dynamic: home-page
26
+ Dynamic: keywords
27
+ Dynamic: license
28
+ Dynamic: requires-dist
29
+ Dynamic: summary
30
+
31
+ # ofxstatement-paypal
32
+
33
+ ### Paypal plugin for ofxstatement
34
+
35
+ This project provides a custom plugin for [ofxstatement](https://github.com/kedder/ofxstatement) for Paypal. It is based
36
+ on the work done by gerasiov (https://github.com/gerasiov/ofxstatement-paypal/).
37
+
38
+ `ofxstatement`_ is a tool to convert proprietary bank statement to OFX format, suitable for importing to GnuCash / Odoo. Plugin for ofxstatement parses a particular proprietary bank statement format and produces common data structure, that is then formatted into an OFX file.
39
+
40
+ Users of ofxstatement have developed several plugins for their banks. They are listed on main [`ofxstatement`](https://github.com/kedder/ofxstatement) site. If your bank is missing, you can develop your own plugin.
41
+
42
+ > This repository is a fork of the original project, afrter the original author did not respond to the pull request, we decided to create a new repository to maintain the project.
43
+
44
+ ## Installation
45
+
46
+ ### From PyPI repositories
47
+ ```
48
+ pip3 install ofxstatement-paypal-2
49
+ ```
50
+
51
+ ### From source
52
+ ```
53
+ git clone https://github.com/Alfystar/ofxstatement-paypal-2.git
54
+ cd ofxstatement-paypal
55
+ pip install build
56
+ python3 -m build --sdist --wheel
57
+ ```
58
+
59
+ ### Configuration
60
+
61
+ You have to configure some parameter in your local environment to allow the conversion.
62
+
63
+ To edit the config file, run this command:
64
+
65
+ ```bash
66
+ $ ofxstatement edit-config
67
+ ```
68
+ It's open a `vim` editor with current configuration.
69
+
70
+ Now add plug-in configuration, here is example with the default configuration:
71
+
72
+ ```ini
73
+ [Conf-Name]
74
+ plugin = paypal-convert
75
+ encoding = utf-8
76
+ dataformat = %%d/%%m/%%Y
77
+ default_account = Paypal Personal
78
+ ```
79
+
80
+ Now, base on your country, edit:
81
+
82
+ - `Conf-Name`: is a text string, you can name it as you wish. Is used to identify the configuration selected when you run `ofxstatement convert -t <Conf-Name> input.csv output.ofx`.
83
+ - `dataformat`: open your PayPal CSV and see your specific data-format.
84
+ - `%%d/%%m/%%Y` is Europe standard.
85
+ - `%%m/%%d/%%Y` is USA standard.
86
+ - etc...
87
+ - `default_account`: is text string, add on the beginning of the OFX file, help some program, like [Home Bank](http://homebank.free.fr/en/index.php), to detect witch account is used and help in import phase.
88
+
89
+ > Keep in mind you can have all the configuration you want, just add a new section with the same structure and change the name of the section.
90
+
91
+ ## Usage
92
+
93
+ From Paypal Web interface, download a CSV of `Bank statements` with the personalized report period you wish. (PayPal Login :arrow_right: History :arrow_right: Download :arrow_right: customized)
94
+
95
+ <img src="BankStatements.png" alt="Bank statements guide" style="zoom:50%;" />
96
+
97
+ Finally, open terminal in the directory where you download the report and type:
98
+
99
+ ```bash
100
+ $ ofxstatement convert -t <Conf-Name> input.csv output.ofx
101
+ ```
102
+
103
+ ### Add Alias
104
+ To simplify the use of the plugin, we strongly recommend adding an alias to your system (if in a Linux environment or on an emulated terminal) by adding the alias of this command to your *.bash_aliases*:
105
+ > **Note**: this alias use for confuguration name `paypal`, if you use another name, change it in the alias
106
+
107
+ ```bash
108
+ $ printf '\n# Paypal CSV convert to OFX format\nalias ofxPaypal="ofxstatement convert -t paypal"\n' >> ~/.bash_aliases
109
+ ```
110
+ After that, reload your terminal (close and then reopen) and the usage change to:
111
+ ```bash
112
+ $ ofxPaypal Paypal.csv Paypal.ofx
113
+ ```
114
+ **Note**: If after reload alias are not loading, go in your *.bashrc* and check if follow line are present, if not, add it on the end:
115
+ ```bash
116
+ # Alias definitions.
117
+ # You may want to put all your additions into a separate file like
118
+ # ~/.bash_aliases, instead of adding them here directly.
119
+ # See /usr/share/doc/bash-doc/examples in the bash-doc package.
120
+
121
+ if [ -f ~/.bash_aliases ]; then
122
+ . ~/.bash_aliases
123
+ fi
124
+ ```
125
+
126
+
127
+
128
+ ## How use OFX file after conversion
129
+
130
+ The `ofx` format stands for '*Open Financial Exchange*', it can be used to transfer your accounting records from one database to another.
131
+ Once you have the `ofx` file, you can use any program to manage your finances.
132
+ Among the many available, a non-exhaustive list of open source products is:
133
+
134
+ - [HomeBank](http://homebank.free.fr/en/index.php), continuously updated program, present everywhere except in smartphones, with many beautiful ideas and listening to the community. **100% compatibility**
@@ -0,0 +1,14 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ setup.cfg
5
+ setup.py
6
+ src/ofxstatement/plugins/__init__.py
7
+ src/ofxstatement/plugins/paypal.py
8
+ src/ofxstatement_paypal_2.egg-info/PKG-INFO
9
+ src/ofxstatement_paypal_2.egg-info/SOURCES.txt
10
+ src/ofxstatement_paypal_2.egg-info/dependency_links.txt
11
+ src/ofxstatement_paypal_2.egg-info/entry_points.txt
12
+ src/ofxstatement_paypal_2.egg-info/requires.txt
13
+ src/ofxstatement_paypal_2.egg-info/top_level.txt
14
+ src/ofxstatement_paypal_2.egg-info/zip-safe
@@ -0,0 +1,2 @@
1
+ [ofxstatement]
2
+ paypal-convert = ofxstatement.plugins.paypal:PayPalPlugin