2900d953e5
Updates the requirements on [flask](https://github.com/pallets/flask) to permit the latest version. - [Release notes](https://github.com/pallets/flask/releases) - [Changelog](https://github.com/pallets/flask/blob/main/CHANGES.rst) - [Commits](https://github.com/pallets/flask/compare/2.1.0...2.1.1) --- updated-dependencies: - dependency-name: flask dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .. | ||
| app | ||
| deploy | ||
| tests | ||
| .env.example | ||
| app.py | ||
| Dockerfile | ||
| README.md | ||
| requirements.txt | ||
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)
- Use
.env-file inapidirectory like.env.example - Or set variables using
exportorsetcommands. (Windowsset, Linuxexport)
- Use
- 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)
- Use
.env-file inapidirectory like.env.example - Or set variables using
exportorsetcommands. (Windowsset, Linuxexport)
- Use
- 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>