Metadata-Version: 1.1
Name: ofxtools
Version: 0.1
Summary: Library for working with Open Financial Exchange (OFX)formatted data used by financial institutions
Home-page: https://github.com/csingley/ofxtools
Author: Christopher Singley
Author-email: csingley@gmail.com
License: MIT
Download-URL: https://github.com/csingley/ofxtools/tarball/0.1
Description: ofxtools is a Python library for working with Open Financial Exchange (OFX)
        data - both OFXv1 (SGML) and OFXv2 (pure XML) - which is the standard format
        for downloading financial information from banks and stockbrokers.
        
        ofxtools has no external dependencies beyond stdlib, and is compatible with
        Python version 2.6+ (including Python 3).
        
        The primary faclities provided include:
            * The OFXClient class; which dowloads OFX statements from the Internet
            * The OFXParser class; which parses OFX data into a standard ElementTree
              structure for further processing in Python.
            * The OFXResponse class; which validates and converts OFX data parsed by
              OFXParser into Python types and exposes them through more Pythonic
              attribute access (e.g. OFXResponse.statements[0].ledgerbal)
        
        INSTALLATION
        Use the Python user installation scheme:
            `python setup.py install --user`
        
        In addition to the Python package, this will also install a script 'ofxget'
        in ~/.local/bin, and a sample configuration file in ~/.config/ofxtools
        
        
        BASIC USAGE TO DOWNLOAD OFX:
            1) Copy ~/.config/ofxtools/ofxget_example.cfg to ~/.config/ofxtools/ofxget.cfg and edit.
                Add a section for your financial institution, including URL, 
                account information, login, etc.
                See comments within.
            2) Execute ofxget with appropriate arguments, e.g.
                `# ofxget amex stmt -s 20140101 -e 20140630 > foobar.ofx`
                See the --help for explanation of the script options
        
        PARSER USAGE EXAMPLE
        
        >>> from ofx import OFXTree
        >>> tree = OFXTree()
        >>> tree.parse('foobar.ofx')
        >>> response = tree.convert()
        >>> response                  
        <OFXResponse fid='AIS' org='Ameritrade Technology Group' dtserver='2014-12-01 16:11:44' len(statements)=1 len(securities)=5>
        >>> stmt = response.statements[0] 
        >>> stmt
        <InvestmentStatement account=<INVACCTFROM acctid='000000000' brokerid='ameritrade.com'> currency='USD' balances=<INVBAL buypower='3466.92' marginbalance='-488.6' shortbalance='-2830.001953' availcash='1469.51'> len(other_balances)=23 len(positions)=4 len(transactions)=5>
        >>> stmt.positions[2]
        <POSSTOCK dtpriceasof='2014-11-28 12:00:00' mktval='2313' postype='LONG' heldinacct='MARGIN' uniqueidtype='CUSIP' uniqueid='527288104' units='100' unitprice='23.13'>
        >>> stmt.transactions[3]
        <SELLSTOCK selltype='SELL' uniqueid='404139107' memo='SELL TRADE' subacctfund='MARGIN' units='-2704' uniqueidtype='CUSIP' dttrade='2014-11-13 11:16:59' fees='0.41' total='18376.8' commission='9.99' fitid='12386048052' subacctsec='MARGIN' unitprice='6.8'>
        >>> response.securities[1]
        <STOCKINFO secname='HC 2 HOLDINGS INC (QB)' uniqueidtype='CUSIP' uniqueid='404139107' ticker='HCHC'>
        
Keywords: ofx,Open Financial Exchange
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Topic :: Office/Business
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
