Browse Source

README, setup: Update docs and package

feature/fints
Jakub Valenta 3 years ago
parent
commit
4617bed937
2 changed files with 12 additions and 11 deletions
  1. 9
    9
      README.md
  2. 3
    2
      setup.py

+ 9
- 9
README.md View File

@@ -4,8 +4,8 @@ Retrieve a bank account statement.

Supported banks:

- [Any bank with HBCI interface](https://github.com/monofox/python-aqbanking)
- [Fio](https://www.fio.cz/)
- [HBCI via AqBanking](https://github.com/monofox/python-aqbanking)

## Installation

@@ -14,23 +14,23 @@ This software requires Python 3. See [Python's website](https://www.python.org/)
When you have Python 3 installed, install required packages with pip (Python's package management system):

```
pip install attrs
pip install requests
pip install python-aqbanking
# pip install attrs
# pip install listio
# pip install python-aqbanking
# pip install requests
```

Then you can call the executable:

```
./account-statement -h
$ ./account-statement -h
```

Or you can install this software as a Python package, which will also install all the dependencies and make the executable available globally:

```
python setup.py install

account-statement -h
# python setup.py install
$ account-statement -h
```

## Help
@@ -38,7 +38,7 @@ account-statement -h
Call the executable mentioned in [Usage](#usage) with the parameter `-h` or `--help` to see full documentation. Example:

```
account-statement -h
$ account-statement -h
```

## Contributing

+ 3
- 2
setup.py View File

@@ -15,7 +15,7 @@ setup(
description='Retrieve a bank account statement',
long_description=long_description,

url='https://lab.saloun.cz/jakub/account-statements',
url='https://lab.saloun.cz/jakub/account-statement',

author='Jakub Valenta',
author_email='jakub@jakubvalenta.cz',
@@ -36,8 +36,9 @@ setup(

install_requires=[
'attrs',
'requests',
'listio',
'python-aqbanking',
'requests',
],

entry_points={

Loading…
Cancel
Save