Metadata-Version: 1.1
Name: py-nacha
Version: 0.1.2
Summary: NACHA File Generation
Home-page: https://github.com/DisruptiveLabs/nacha
Author: DisruptiveLabs
Author-email: team+nacha@comanage.com
License: UNKNOWN
Description: =====
        nacha
        =====
        
        .. image:: https://travis-ci.org/DisruptiveLabs/nacha.png
           :target: https://travis-ci.org/DisruptiveLabs/nacha
        
        .. image:: https://coveralls.io/repos/DisruptiveLabs/nacha/badge.png?branch=master
          :target: https://coveralls.io/r/DisruptiveLabs/nacha?branch=master
        
        `NACHA <http://www.regaltek.com/docs/NACHA Format.pdf>`_ is a fixed sized
        record format used to represent financial transactions composed like this:
        
        .. code::
        
            FileHeader
                CompanyBatchHeader
                    EntryDetail
                        EntryDetailAddendum
                        ...
                    ...
                CompanyBatchControl
                ...
            FileControl
        
        which we express using `bryl <https://github.com/balanced/bryl/>`_. Writing is
        done like this:
        
        .. code:: python
        
            with open('sample.nacha', 'w') as fo:
                writer = nacha.Writer(fo)
                with writer.begin_file(
                     ...
                     ):
                     with writer.begin_company_batch(
                          ...
                          ):
                         writer.entry(...):
                         ...
                    ...
        
        Reading is done by iterating records like this:
        
        .. code:: python
        
            with open('sample.nacha', 'r') as fo:
                reader = Reader(fo, include_terminal=True)
                for record, terminal in reader:
                    ...
        
        Or structured like this:
        
        .. code:: python
        
            with open('sample.nacha', 'r') as fo:
                reader = Reader(fo)
                reader.file_header()
                for company_batch_header in reader.company_batches():
                    for entry_detail, entry_addenda in reader.entries():
                        ...
                    reader.company_batch_control()
                reader.file_control()
        
        ===
        use
        ===
        
        .. code:: bash
        
           $ pip install py-nacha
        
        ===
        dev
        ===
        
        .. code:: bash
        
           $ git clone git@github.com:DisruptiveLabs/nacha.git
           $ cd nacha
           $ mkvirtualenv nacha
           (nacha)$ pip install -e .[tests]
           (nacha)$ py.test tests.py --cov=nacha --cov-report term-missing 
        
        =======
        release
        =======
        
        Now that all tests are passing:
        
        - Update ``nacha.__version__`` to new ``{version}``.
        - Commit that ``git commit -am "Release v{version}"``
        - Tag it ``git tag -a v{version} -v  v{version}``
        - Push it ``git push origin --tags``
        
        and `travis <https://travis-ci.org/DisruptiveLabs/nacha>`_ will take it from there.
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
