ofx-processor/README.md

48 lines
2.8 KiB
Markdown
Raw 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)
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Crocmagnon/ofx-processor?include_prereleases)
![License](https://img.shields.io/github/license/Crocmagnon/ofx-processor)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Crocmagnon/ofx-processor/Test%20&%20publish)
![Sonar Coverage](https://img.shields.io/sonar/coverage/Crocmagnon_ofx-processor?server=https%3A%2F%2Fsonarcloud.io)
2020-02-29 17:14:36 +01:00
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=bugs)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=code_smells)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=alert_status)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=security_rating)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Crocmagnon_ofx-processor&metric=sqale_index)](https://sonarcloud.io/dashboard?id=Crocmagnon_ofx-processor)
2020-02-29 17:30:20 +01:00
2020-01-15 14:42:57 +01:00
## Usage
2020-01-17 16:35:56 +01:00
```shell script
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
This project follows [Semantic Versioning](https://semver.org/).