Metadata-Version: 2.0
Name: bai-lockbox
Version: 0.0.4
Summary: A library for parsing files in the BAI lockbox format.
Home-page: https://www.github.com/FundersClub/bai-lockbox
Author: Jon Friedman / FundersClub Inc.
Author-email: jon@fundersclub.com
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Requires-Dist: six

bai-lockbox
===========

A simple parser for files in the BAI lockbox format in order to extract checks
from them.


Installation
------------

To install `bai-lockbox`::

  $ pip install bai-lockbox


Warning
-------

Please be aware that this code was written to the spec that our bank uses, and
has been tested with data that has come from them. This means that there may be
subtle (and maybe some not-so-subtle) differences between the the data we expect
and the data you get. If our parser doesn't read your files, open an issue or
submit a PR. We'd really appreciate it!

Usage
-----

.. code-block:: python

    from lockbox.parser import LockboxFile
    with open('/path/to/file', 'r') as inf:
        lockbox_file = LockboxFile.from_file(inf)

    for check in lockbox_file.checks:
        print('Received ${} from {} on {}'.format(
            check.amount, check.sender, check.date
        ))

More information can be found in the docs which can be build from source::

  $ cd path/to/bai-lockbox/docs
  $ make html

or by going to the `documentation page <https://fundersclub.github.io/bai-lockbox>`_.


