Open Financial Exchange (OFX) Tools for Python
==============================================
.. image:: https://github.com/csingley/ofxtools/actions/workflows/commit-ofxtools.yml/badge.svg
:alt: CI tests status
:target: https://github.com/csingley/ofxtools/actions/workflows/commit-ofxtools.yml
.. image:: https://coveralls.io/repos/github/csingley/ofxtools/badge.svg?branch=master
:target: https://coveralls.io/github/csingley/ofxtools?branch=master
.. image:: https://img.shields.io/badge/dependencies-None-green.svg
:target: https://github.com/csingley/ofxtools/blob/master/requirements.txt
.. image:: https://badge.fury.io/py/ofxtools.svg
:target: https://badge.fury.io/py/ofxtools
``ofxtools`` is a Python library for working with Open Financial Exchange (OFX)
data - the standard format for downloading financial information from banks
and stockbrokers. OFX data is widely provided by financial institutions so
that their customers can import transactions into financial management
software such as Quicken, Microsoft Money, or GnuCash.
If you want to download your transaction data outside of one of these
programs - if you wish to develop a Python application to use this data -
if you need to generate your own OFX-formatted data... ``ofxtools`` is for you!
What is it?
-----------
``ofxtools`` requests, consumes and
produces both OFXv1 (SGML) and OFXv2 (XML) formats.
It converts serialized markup to/from native Python objects of
the appropriate data type, while preserving structure.
It also handles Quicken's QFX format, although it ignores Intuit's proprietary
extension tags.
In a nutshell, ``ofxtools`` makes it simple to get OFX data and extract it,
or export your data in OFX format.
``ofxtools`` takes a comprehensive, standards-based approach to processing OFX.
It targets compliance with the `OFX specification`_, specifically OFX versions
1.6 and 2.03.
``ofxtools`` Coverage of the OFX Specification
* Section 7 (financial institution profile)
* Section 8 (service activation; account information)
* Section 9 (email over OFX)
* Section 10 (recurring bank transfers)
* Section 11 (banking)
* Section 12 (bill pay)
* Section 13 (investments)
This should cover the great majority of real-world OFX use cases. A particular
focus of ``ofxtools`` is full support of the OFX investment message set,
which has been somewhat neglected by the Python community.
The major item remaining on the ``ofxtools`` "to do" list is to implement the
tax schemas. It's currently a low priority to implement Section 14 (bill
presentment) or the extensions contained in OFX versions beyond 2.03, but
you're welcome to contribute code if you need these.
Some care has been taken with the data model to make it easily maintainable
and extensible. The ``ofxtools.models`` subpackage contains simple, direct
translations of the relevant sections of the OFX specification. Using existing
models as templates, it's quite straightforward to define new models and
cover more of the spec as needed (the odd corner case notwithstanding).
More than 10 years' worth of OFX data from various financial institutions
has been run through the ``ofxtools`` parser, with the results checked. Test
coverage is high.
Where is it?
------------
Full documentation is available at `Read the Docs`_.
For ease of installation, ``ofxtools`` is released on `PyPI`_.
Development of ``ofxtools`` is centralized at `GitHub`_, where you will find
a `bug tracker`_.
Installation Dependencies
-------------------------
``ofxtools`` requires Python version 3.8+, and depends only on the standard
libary (no external dependencies).
**NOTE: As of version 0.6, ofxtools no longer supports Python version 2,
which went EOL 2020-01-01.**
.. _OFX specification: https://financialdataexchange.org/ofx
.. _Requests: http://docs.python-requests.org/en/master/
.. _Read the Docs: https://ofxtools.readthedocs.io/
.. _GitHub: https://github.com/csingley/ofxtools
.. _bug tracker: https://github.com/csingley/ofxtools/issues
.. _PyPI: https://pypi.python.org/pypi/ofxtools
Raw data
{
"_id": null,
"home_page": "https://github.com/csingley/ofxtools",
"name": "ofxtools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ofx,Open Financial Exchange",
"author": "Christopher Singley",
"author_email": "csingley@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/37/d224428cbb44b8d36b9458c2c9b11eb54ece95bc455ef6f7ada583809b13/ofxtools-0.9.5.tar.gz",
"platform": "",
"description": "Open Financial Exchange (OFX) Tools for Python\n==============================================\n\n.. image:: https://github.com/csingley/ofxtools/actions/workflows/commit-ofxtools.yml/badge.svg\n :alt: CI tests status\n :target: https://github.com/csingley/ofxtools/actions/workflows/commit-ofxtools.yml\n\n.. image:: https://coveralls.io/repos/github/csingley/ofxtools/badge.svg?branch=master\n :target: https://coveralls.io/github/csingley/ofxtools?branch=master\n\n.. image:: https://img.shields.io/badge/dependencies-None-green.svg\n :target: https://github.com/csingley/ofxtools/blob/master/requirements.txt \n\n.. image:: https://badge.fury.io/py/ofxtools.svg\n :target: https://badge.fury.io/py/ofxtools\n\n``ofxtools`` is a Python library for working with Open Financial Exchange (OFX)\ndata - the standard format for downloading financial information from banks\nand stockbrokers. OFX data is widely provided by financial institutions so\nthat their customers can import transactions into financial management\nsoftware such as Quicken, Microsoft Money, or GnuCash.\n\nIf you want to download your transaction data outside of one of these\nprograms - if you wish to develop a Python application to use this data -\nif you need to generate your own OFX-formatted data... ``ofxtools`` is for you!\n\nWhat is it?\n-----------\n``ofxtools`` requests, consumes and\nproduces both OFXv1 (SGML) and OFXv2 (XML) formats.\nIt converts serialized markup to/from native Python objects of\nthe appropriate data type, while preserving structure.\nIt also handles Quicken's QFX format, although it ignores Intuit's proprietary\nextension tags.\n\nIn a nutshell, ``ofxtools`` makes it simple to get OFX data and extract it,\nor export your data in OFX format.\n\n``ofxtools`` takes a comprehensive, standards-based approach to processing OFX.\nIt targets compliance with the `OFX specification`_, specifically OFX versions\n1.6 and 2.03.\n\n``ofxtools`` Coverage of the OFX Specification\n * Section 7 (financial institution profile)\n * Section 8 (service activation; account information)\n * Section 9 (email over OFX)\n * Section 10 (recurring bank transfers)\n * Section 11 (banking)\n * Section 12 (bill pay)\n * Section 13 (investments)\n\nThis should cover the great majority of real-world OFX use cases. A particular\nfocus of ``ofxtools`` is full support of the OFX investment message set,\nwhich has been somewhat neglected by the Python community.\n\nThe major item remaining on the ``ofxtools`` \"to do\" list is to implement the\ntax schemas. It's currently a low priority to implement Section 14 (bill\npresentment) or the extensions contained in OFX versions beyond 2.03, but\nyou're welcome to contribute code if you need these.\n\nSome care has been taken with the data model to make it easily maintainable\nand extensible. The ``ofxtools.models`` subpackage contains simple, direct\ntranslations of the relevant sections of the OFX specification. Using existing\nmodels as templates, it's quite straightforward to define new models and\ncover more of the spec as needed (the odd corner case notwithstanding).\n\nMore than 10 years' worth of OFX data from various financial institutions\nhas been run through the ``ofxtools`` parser, with the results checked. Test\ncoverage is high.\n\nWhere is it?\n------------\nFull documentation is available at `Read the Docs`_.\n\nFor ease of installation, ``ofxtools`` is released on `PyPI`_.\n\nDevelopment of ``ofxtools`` is centralized at `GitHub`_, where you will find\na `bug tracker`_.\n\nInstallation Dependencies\n-------------------------\n``ofxtools`` requires Python version 3.8+, and depends only on the standard\nlibary (no external dependencies).\n\n**NOTE: As of version 0.6, ofxtools no longer supports Python version 2,\nwhich went EOL 2020-01-01.**\n\n\n.. _OFX specification: https://financialdataexchange.org/ofx\n.. _Requests: http://docs.python-requests.org/en/master/\n.. _Read the Docs: https://ofxtools.readthedocs.io/\n.. _GitHub: https://github.com/csingley/ofxtools\n.. _bug tracker: https://github.com/csingley/ofxtools/issues\n.. _PyPI: https://pypi.python.org/pypi/ofxtools\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Library for working with Open Financial Exchange (OFX) data",
"version": "0.9.5",
"project_urls": {
"Download": "https://github.com/csingley/ofxtools/tarball/0.9.5",
"Homepage": "https://github.com/csingley/ofxtools"
},
"split_keywords": [
"ofx",
"open financial exchange"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce37d224428cbb44b8d36b9458c2c9b11eb54ece95bc455ef6f7ada583809b13",
"md5": "c9a4d667b92cc3aea5de45ad63762590",
"sha256": "682a516bfa5ccad0f9551c17cc2cf155422f9f5f85a341cfb4911b324de46045"
},
"downloads": -1,
"filename": "ofxtools-0.9.5.tar.gz",
"has_sig": false,
"md5_digest": "c9a4d667b92cc3aea5de45ad63762590",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 114090,
"upload_time": "2022-01-13T14:18:16",
"upload_time_iso_8601": "2022-01-13T14:18:16.584527Z",
"url": "https://files.pythonhosted.org/packages/ce/37/d224428cbb44b8d36b9458c2c9b11eb54ece95bc455ef6f7ada583809b13/ofxtools-0.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-01-13 14:18:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csingley",
"github_project": "ofxtools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ofxtools"
}
JSON
