https://github.com/arthurfdlr/beancount-ce

💸 Beancount Importer for Caisse d'Epargne statements (pdf and csv files) - Pypi package
https://github.com/arthurfdlr/beancount-ce

accounting banking beancount finance personal-finance plaintext-accounting pypi python3

Last synced: about 2 months ago
JSON representation

💸 Beancount Importer for Caisse d'Epargne statements (pdf and csv files) - Pypi package

• Host: GitHub
• URL: https://github.com/arthurfdlr/beancount-ce
• Owner: ArthurFDLR
• License: mit
• Created: 2020-09-08T14:13:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-04T06:12:39.000Z (12 months ago)
• Last Synced: 2024-11-02T07:33:11.491Z (2 months ago)
• Topics: accounting, banking, beancount, finance, personal-finance, plaintext-accounting, pypi, python3
• Language: Python
• Homepage: https://pypi.org/project/beancount-ce/
• Size: 72.3 KB
• Stars: 5
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Beancount Caisse d'Epargne Importer

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ArthurFDLR/beancount-ce/beancount-ce?style=for-the-badge)](https://github.com/ArthurFDLR/beancount-ce/actions)

[![PyPI](https://img.shields.io/pypi/v/beancount-ce?style=for-the-badge)](https://pypi.org/project/beancount-ce/)

[![PyPI - Version](https://img.shields.io/pypi/pyversions/beancount-ce.svg?style=for-the-badge)](https://pypi.org/project/beancount-ce/)

[![GitHub](https://img.shields.io/github/license/ArthurFDLR/beancount-ce?style=for-the-badge)](https://github.com/ArthurFDLR/beancount-ce/blob/master/LICENSE.txt)

[![Linting](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)

`beancount-ce` provides a statements (PDF and CSV) importer for the bank [Caisse d'Epargne](http://www.caisse-epargne.fr) to the [Beancount](http://furius.ca/beancount/) format.

## Installation

```console

    $ pip install beancount-ce

```

## Usage

Add ```CEImporter``` to your [Beancount importers config file](https://beancount.github.io/docs/importing_external_data.html#configuration).

```python

    IBAN_NUMBER_CE = 'FR00 1111 2222 3333 4444 5555 666'

    CONFIG = [

        CEImporter(

            iban=IBAN_NUMBER_CE,

            account='Assets:FR:CdE:CompteCourant',

            expenseCat='Expenses:FIXME',    #Optional

            creditCat='Income:FIXME',       #Optional

            showOperationTypes=False        #Optional

        ),

    ]

```

## Contribution

Feel free to contribute!

Please make sure you have Python 3.6+ and [`Poetry`](https://poetry.eustace.io/) installed.

1. Git clone the repository - `git clone https://github.com/ArthurFDLR/beancount-ce`

2. Install the packages required for development - `poetry install`

3. That's basically it. You should now be able to run lint checks and the test suite - `make lint test`.