didier/readme.md

68 lines
2.0 KiB
Markdown
Raw Normal View History

# Didier
2022-07-14 20:28:45 +02:00
[![wakatime](https://wakatime.com/badge/user/3543d4ec-ec93-4b43-abd6-2bc2e310f3c4/project/100156e4-2fb5-40b4-b808-e47ef687905c.svg)](https://wakatime.com/badge/user/3543d4ec-ec93-4b43-abd6-2bc2e310f3c4/project/100156e4-2fb5-40b4-b808-e47ef687905c)
You bet. The time has come.
2022-07-19 21:33:18 +02:00
## Development
2022-07-19 21:33:18 +02:00
Didier uses `Python 3.9.5`, as specified in the [`.python-version`](.python-version)-file. This file will cause [`pyenv`](https://github.com/pyenv/pyenv) to automatically use the correct version when you're working on Didier.
2022-07-19 21:33:18 +02:00
```shell
# Installing Python 3.9.5 through pyenv
pyenv install 3.9.5
2022-07-19 21:33:18 +02:00
# Creating a Virtual Environment and activate it
# PyCharm will automatically activate your venv
python3 -m venv venv
source venv/bin/activate
2022-07-19 21:33:18 +02:00
# Installing dependencies + development dependencies
pip3 install -r requirements.txt -r requirements-dev.txt
2022-07-19 21:33:18 +02:00
# Installing pre-commit hooks
pre-commit install
```
2022-07-19 21:33:18 +02:00
The database can be managed easily using `Docker Compose`. If you want to, however, you can run a regular PostgreSQL server and connect to that instead.
2022-07-19 21:33:18 +02:00
A separate database is used in the tests, as it would obviously not be ideal when tests randomly wipe your database.
2022-07-19 21:33:18 +02:00
```shell
# Starting the database
2022-07-27 21:49:58 +02:00
docker compose up -d
2022-07-19 21:33:18 +02:00
# Starting the database used in tests
2022-07-27 21:49:58 +02:00
docker compose -f docker-compose.test.yml up -d
```
2022-07-19 21:33:18 +02:00
### Commands
2022-08-29 01:17:06 +02:00
_All of these are Python tools. Depending on your OS and configuration, you may have to prefix them with `python3 -m`._
2022-07-19 21:33:18 +02:00
```shell
# Starting Didier
python3 main.py
2022-07-19 22:58:59 +02:00
# Running database migrations
alembic upgrade head
# Creating a new database migration
alembic revision --autogenerate -m "Revision message here"
2022-07-19 21:33:18 +02:00
# Running tests
pytest
2022-07-19 21:33:18 +02:00
# Running tests with Coverage
coverage run -m pytest
# Generating code coverage report
coverage html
2022-07-19 21:33:18 +02:00
# Running code quality checks
black
flake8
mypy
```
2022-07-24 21:35:38 +02:00
It's also convenient to have code-formatting happen automatically on-save. The [`Black documentation`](https://black.readthedocs.io/en/stable/integrations/editors.html) explains how to set this up for different types of editors.