Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/city-of-helsinki/atv
Asiointitietovaranto
https://github.com/city-of-helsinki/atv
Last synced: about 2 months ago
JSON representation
Asiointitietovaranto
- Host: GitHub
- URL: https://github.com/city-of-helsinki/atv
- Owner: City-of-Helsinki
- License: mit
- Created: 2021-05-25T13:36:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T00:22:33.000Z (3 months ago)
- Last Synced: 2024-10-25T06:08:40.854Z (3 months ago)
- Language: Python
- Size: 453 KB
- Stars: 1
- Watchers: 21
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audit_log/README.md
Awesome Lists containing this project
README
# ATV
Asiointitietovaranto Django REST API
[](https://github.com/City-of-Helsinki/atv/actions/workflows/pytest.yml?query=branch:main)
[](https://github.com/City-of-Helsinki/atv/actions/workflows/py-coding-style.yml?query=branch:main)
[](https://codecov.io/gh/City-of-Helsinki/atv)
## Development with [Docker](https://docs.docker.com/)
Prerequisites:
* Docker
* Docker Compose
1. Create a `docker-compose.env.yaml` file in the project folder:
* Use `docker-compose.env.yaml.example` as a base, it does not need any changes for getting the project running.
* Set entrypoint/startup variables according to taste.
* `DEBUG`, controls debug mode on/off
* `APPLY_MIGRATIONS`, applies migrations on startup
* `CREATE_ADMIN_USER`, creates an admin user with credentials `admin`:(password, see below)
([email protected])
* `ADMIN_USER_PASSWORD`, the admin user's password. If this is not given, a random password is generated
and written into stdout when an admin user is created automatically.
2. Run `docker-compose up`
* The project is now running at [localhost:8081](http://localhost:8081)
**Optional steps**
1. Run migrations:
* Taken care by the example env
* `docker exec atv-backend python manage.py migrate`
2. Create superuser:
* Taken care by the example env
* `docker exec -it atv-backend python manage.py add_admin_user`
## Development without Docker
Prerequisites:
* PostgreSQL 14
* Python 3.11
### Installing Python requirements
* Run `pip install -r requirements.txt`
* Run `pip install -r requirements-dev.txt` (development requirements)
### Database
To setup a database compatible with default database settings:
Create user and database
sudo -u postgres createuser -P -R -S atv # use password `atv`
sudo -u postgres createdb -O atv atv
Allow user to create test database
sudo -u postgres psql -c "ALTER USER atv CREATEDB;"
### Daily running
* Create `.env` file: `touch .env`
```dotenv
DEBUG=1
DATABASE_URL=postgres://atv:atv@localhost:5437/atv
# Optionals (with a default value on settings.py)
FIELD_ENCRYPTION_KEYS=
```
* Set the `DEBUG` environment variable to `1`.
* Run `python manage.py migrate`
* Run `python manage.py add_admin_user`
* Run `python manage.py runserver 0:8000`
The project is now running at [localhost:8000](http://localhost:8000)
## Keeping Python requirements up to date
1. Install `pip-tools`:
* `pip install pip-tools`
2. Add new packages to `requirements.in` or `requirements-dev.in`
3. Update `.txt` file for the changed requirements file:
* `pip-compile requirements.in`
* `pip-compile requirements-dev.in`
4. If you want to update dependencies to their newest versions, run:
* `pip-compile --upgrade requirements.in`
5. To install Python requirements run:
* `pip-sync requirements.txt`
## Code format
This project uses
[`black`](https://github.com/ambv/black),
[`flake8`](https://gitlab.com/pycqa/flake8) and
[`isort`](https://github.com/timothycrosley/isort)
for code formatting and quality checking. Project follows the basic
black config, without any modifications.
Basic `black` commands:
* To let `black` do its magic: `black .`
* To see which files `black` would change: `black --check .`
[`pre-commit`](https://pre-commit.com/) can be used to install and
run all the formatting tools as git hooks automatically before a
commit.
## Running tests
* Set the `DEBUG` environment variable to `1`.
* Run `pytest`.