ofx-processor/README.md

58 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2020-01-15 14:42:57 +01:00
# ofx-processor
2020-02-29 17:30:20 +01:00
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ofx-processor)
![PyPI - Format](https://img.shields.io/pypi/format/ofx-processor)
![PyPI - Status](https://img.shields.io/pypi/status/ofx-processor)
2021-11-18 18:51:52 +01:00
## Install
```shell
python -m pip install ofx-processor
```
https://pypi.org/project/ofx-processor/
2020-02-29 17:30:20 +01:00
2020-01-15 14:42:57 +01:00
## Usage
2021-11-18 18:51:52 +01:00
```
2020-02-26 18:26:36 +01:00
Usage: ynab [OPTIONS] COMMAND [ARGS]...
2020-02-29 18:26:32 +01:00
Import your data to YNAB with the processors listed below or manage your
config.
2020-02-26 18:26:36 +01:00
Options:
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
2020-02-29 18:26:32 +01:00
config Manage configuration.
bpvf Import BPVF bank statement (OFX file).
ce Import CE bank statement (OFX file).
2020-05-08 18:03:19 +02:00
lcl Import LCL bank statement (OFX file).
2020-02-29 18:26:32 +01:00
revolut Import Revolut bank statement (CSV file).
2020-01-15 14:42:57 +01:00
```
2020-02-26 18:26:36 +01:00
All transactions will be pushed to YNAB. If this is your first time using the script,
it will open a generated config file for you to fill up.
2020-01-15 14:42:57 +01:00
2020-02-26 18:26:36 +01:00
The account and budget UUID are found in the YNAB url when using the web app.
2020-05-08 18:03:19 +02:00
The file passed in parameter will be deleted unless specified (`--keep` option on each import command)
## Versions
2021-11-18 19:06:40 +01:00
This project follows [Semantic Versioning](https://semver.org/).
2021-12-04 11:38:09 +01:00
## Development
### Release
```shell
inv full-test
poetry version <major/minor/patch>
git add .
git commit
2024-10-14 19:58:25 +02:00
inv tag $(poetry version -s)
2021-12-04 11:38:09 +01:00
inv publish publish-docker
```
2022-01-02 19:29:42 +01:00
# Reuse
If you do reuse my work, please consider linking back to this repository 🙂