Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
senz committed Nov 30, 2024
1 parent c9ba1f0 commit eca820d
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ CSV statement for debit card.

Raiffeisen
-------
TODO: Add description

CSV statemenr for account.
Basic support for DEBIT and CREDIT transactions.

Plugin configuration parameters
===============================
Expand Down Expand Up @@ -140,26 +141,38 @@ user_date

raiffeisen
--------
TODO: Add description

bank
Bank id
(default is 'Raiffeisen')

account
Account id

currency
Currency


Development
===========

Project is targeting python 3 (3.9 for sure as current widespread version) and
pytest is used for testing.

Development setup is simple:
Recommended way to setup is with DevContainer in VSCode.

Manual development setup is as follows:

1. Create virtual environment and activate it
.. code-block:: bash
pipenv sync --dev
pipenv shell
make install
poetry shell
2. Run tests using pytest
.. code-block:: bash
pytest
make test
Expand Down

0 comments on commit eca820d

Please sign in to comment.