Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/csingley/ofxtools

Python OFX Library
https://github.com/csingley/ofxtools

Last synced: about 1 month ago
JSON representation

Python OFX Library

Awesome Lists containing this project

README 

        
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