Bankline Direct Parser
======================
Python module for parsing Natwest/RBS Bankline Direct Data Services files.
Requirements
------------
Only Python 3.7+ is supported.
Installation
------------
.. code-block:: shell
pip install bankline-direct-parser
Usage
-----
.. code-block:: python
from bankline_parser.data_services import parse
# from file
with open(filename) as f:
parsed = parse(f)
if parsed.is_valid():
print(parsed.accounts[0].records[0].transaction_code)
else:
print(parsed.errors)
# from list of rows
parsed = parse(lines)
Model Layout
------------
.. code-block::
DataServicesFile
VolumeHeaderLabel
[Account]
FileHeaderLabel
UserHeaderLabel
[DataRecord|BalanceRecord]
UserTrailerLabel
Development
-----------
.. image:: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/test.yml
.. image:: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/lint.yml/badge.svg?branch=main
:target: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/lint.yml
Please report bugs and open pull requests on `GitHub`_.
To work on changes to this library, it’s recommended to install it in editable mode into a virtual environment,
i.e. ``pip install --editable .``
Use ``python -m tests`` to run all tests locally.
Alternatively, you can use ``tox`` if you have multiple python versions.
[Only for GitHub team members] Distribute a new version to `PyPI`_ by:
- updating the ``VERSION`` tuple in ``bankline_parser/__init__.py``
- adding a note to the `History`_
- publishing a release on GitHub which triggers an upload to PyPI;
alternatively, run ``python -m build; twine upload dist/*`` locally
History
-------
0.8
Migrated test, build and release processes away from deprecated setuptools commands.
No significant library changes.
0.7
Maintenance release, no library changes.
0.2 - 0.6
No significant library changes, other than support for newer versions of python.
0.1
Original release.
Copyright
---------
Copyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).
See LICENSE.txt for further details.
.. _GitHub: https://github.com/ministryofjustice/bankline-direct-parser
.. _PyPI: https://pypi.org/project/bankline-direct-parser/
Raw data
{
"_id": null,
"home_page": "https://github.com/ministryofjustice/bankline-direct-parser",
"name": "bankline-direct-parser",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "bankline",
"author": "Ministry of Justice Digital & Technology",
"author_email": "dev@digital.justice.gov.uk",
"download_url": "https://files.pythonhosted.org/packages/f2/79/055e874009f9a36f93d4c9d50b6c631f68ece54e4a64e28c7e5cde4b868b/bankline-direct-parser-0.8.tar.gz",
"platform": null,
"description": "Bankline Direct Parser\n======================\n\nPython module for parsing Natwest/RBS Bankline Direct Data Services files.\n\nRequirements\n------------\n\nOnly Python 3.7+ is supported.\n\nInstallation\n------------\n\n.. code-block:: shell\n\n pip install bankline-direct-parser\n\nUsage\n-----\n\n.. code-block:: python\n\n from bankline_parser.data_services import parse\n\n # from file\n with open(filename) as f:\n parsed = parse(f)\n if parsed.is_valid():\n print(parsed.accounts[0].records[0].transaction_code)\n else:\n print(parsed.errors)\n\n # from list of rows\n parsed = parse(lines)\n\nModel Layout\n------------\n\n.. code-block::\n\n DataServicesFile\n VolumeHeaderLabel\n [Account]\n FileHeaderLabel\n UserHeaderLabel\n [DataRecord|BalanceRecord]\n UserTrailerLabel\n\nDevelopment\n-----------\n\n.. image:: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/test.yml/badge.svg?branch=main\n :target: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/test.yml\n\n.. image:: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/lint.yml/badge.svg?branch=main\n :target: https://github.com/ministryofjustice/bankline-direct-parser/actions/workflows/lint.yml\n\nPlease report bugs and open pull requests on `GitHub`_.\n\nTo work on changes to this library, it\u2019s recommended to install it in editable mode into a virtual environment,\ni.e. ``pip install --editable .``\n\nUse ``python -m tests`` to run all tests locally.\nAlternatively, you can use ``tox`` if you have multiple python versions.\n\n[Only for GitHub team members] Distribute a new version to `PyPI`_ by:\n\n- updating the ``VERSION`` tuple in ``bankline_parser/__init__.py``\n- adding a note to the `History`_\n- publishing a release on GitHub which triggers an upload to PyPI;\n alternatively, run ``python -m build; twine upload dist/*`` locally\n\nHistory\n-------\n\n0.8\n Migrated test, build and release processes away from deprecated setuptools commands.\n No significant library changes.\n\n0.7\n Maintenance release, no library changes.\n\n0.2 - 0.6\n No significant library changes, other than support for newer versions of python.\n\n0.1\n Original release.\n\nCopyright\n---------\n\nCopyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).\nSee LICENSE.txt for further details.\n\n.. _GitHub: https://github.com/ministryofjustice/bankline-direct-parser\n.. _PyPI: https://pypi.org/project/bankline-direct-parser/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parser for Bankline Direct banking information services",
"version": "0.8",
"project_urls": {
"Homepage": "https://github.com/ministryofjustice/bankline-direct-parser"
},
"split_keywords": [
"bankline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95ddd04413b4003eb445618de5c5d4b3e5664b6281f34b6fea7bedf533fea7be",
"md5": "6b4ed380d67afee270bf230e8ba71eb6",
"sha256": "40620c9a940713d4f6deca450b154f42353eea9c2f22e8a58083f22921f783eb"
},
"downloads": -1,
"filename": "bankline_direct_parser-0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b4ed380d67afee270bf230e8ba71eb6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8363,
"upload_time": "2023-11-16T15:32:43",
"upload_time_iso_8601": "2023-11-16T15:32:43.755129Z",
"url": "https://files.pythonhosted.org/packages/95/dd/d04413b4003eb445618de5c5d4b3e5664b6281f34b6fea7bedf533fea7be/bankline_direct_parser-0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f279055e874009f9a36f93d4c9d50b6c631f68ece54e4a64e28c7e5cde4b868b",
"md5": "de50c4c48c7027c5b69cf8a0f81a4c60",
"sha256": "736ae10b79379c03b0d651b58b6e5ce37c621ccd877948f2569bcabb22840d38"
},
"downloads": -1,
"filename": "bankline-direct-parser-0.8.tar.gz",
"has_sig": false,
"md5_digest": "de50c4c48c7027c5b69cf8a0f81a4c60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8457,
"upload_time": "2023-11-16T15:32:45",
"upload_time_iso_8601": "2023-11-16T15:32:45.024288Z",
"url": "https://files.pythonhosted.org/packages/f2/79/055e874009f9a36f93d4c9d50b6c631f68ece54e4a64e28c7e5cde4b868b/bankline-direct-parser-0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 15:32:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ministryofjustice",
"github_project": "bankline-direct-parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "bankline-direct-parser"
}
JSON
