History

dependabot[bot] 185d222cca Update faker requirement from ~=13.7.0 to ~=13.11.0 in /api Updates the requirements on [faker](https://github.com/joke2k/faker) to permit the latest version. - [Release notes](https://github.com/joke2k/faker/releases) - [Changelog](https://github.com/joke2k/faker/blob/master/CHANGELOG.md) - [Commits](https://github.com/joke2k/faker/compare/v13.7.0...v13.11.0) --- updated-dependencies: - dependency-name: faker dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>		2022-05-10 09:51:29 +00:00
..
app	Use ISIN numbers instead of share symbols and add comment field to database.	2022-04-19 08:20:28 +02:00
deploy	Changed some file to test pipeline execution	2022-04-04 16:08:08 +02:00
tests	Added file headers	2022-04-12 09:50:24 +02:00
.env.example	Save symbol price in database	2022-04-05 15:08:57 +02:00
app.py	Added file headers	2022-04-12 09:50:24 +02:00
Dockerfile	Updated Dockerfile	2022-04-05 19:08:09 +02:00
generate_sample_transactions.py	Removed code	2022-04-12 12:16:25 +02:00
load_share_price.py	Updated load_share_price.py	2022-05-09 14:22:17 +02:00
README.md	Update README.md	2022-03-30 10:51:38 +02:00
requirements.txt	Update faker requirement from ~=13.7.0 to ~=13.11.0 in /api	2022-05-10 09:51:29 +00:00

README.md

API

Aktienbot API

Development

Create virtual environment python -m venv venv env/Scripts/activate
Install requirements pip install -r api/requirements.txt
Set environment variables (see list below)
1. Use .env-file in api directory like .env.example
2. Or set variables using export or set commands. (Windows set, Linux export)
Run api python api/app.py

Testing

Create virtual environment python -m venv venv env/Scripts/activate
Install requirements pip install -r api/requirements.txt
Set environment variables (see list below)
1. Use .env-file in api directory like .env.example
2. Or set variables using export or set commands. (Windows set, Linux export)
Change directory: cd api/
Run tests: python -m pytest -v --cov-report term-missing --cov=app

Environment variables

    # Flask secret key
    SECRET_KEY=
    
    # MYSQL Connection
    MYSQL_USER=
    MYSQL_PASSWORD=
    MYSQL_HOST=
    MYSQL_PORT=
    MYSQL_DATABASE=

Docker

docker run -d \
    --name aktienbot_api \
    --hostname aktienbot_api \
    --publish 80:80 \
    --env "SECRET_KEY=" \
    --env "MYSQL_USER=" \
    --env "MYSQL_PASSWORD=" \
    --env "MYSQL_HOST=" \
    --env "MYSQL_PORT=" \
    --env "MYSQL_DATABASE=" \
    --restart unless-stopped \
    registry.flokaiser.com/aktienbot/api:latest

or load environment variables from file by using --env-file <filename>