gsbparse

A Python parser for Grisbi's .gsb files.

User Quickstart

gsbparse provides two main classes for easily using content of a Grisbi's .gsb file in Python: gsbparse.AccountFile and gsbparse.Transactions. Both classes are instantiated with a pointer to a .gsb file: either filepath (str) or a file object itself.

Installation

You can install gsbparse from PyPI:

pip install gsbparse

How to use

from gsbparse import AccountFile

AccountFile("path/to/my_account_file.gsb")

Development Quickstart

This project adheres to Semantic Versioning, and releases descriptions can be found in CHANGELOG.md.

Use your own environment management preference

For pyvenv:

python -m venv .venv/
source .venv/bin/activate

Install this package

git clone git@github.com:EBoisseauSierra/gsbparse.git
cd gsbparse
pip install --upgrade pip
pip install -e '.[dev,test]'

Initialise pre-commit hooks

The pre-commit hooks defined in this repo ensure that code formating and linting is applied on any piece of code committed. This should enable a cleaner code base and less “formatting noise” in commits.

To install the hooks, simply run:

pre-commit install

Contributing

1. Fork this repo (https://github.com/EBoisseauSierra/gsbparse/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request