Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.91 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.91 KB
Raw

ebau-gwr

Build Status Coverage Ruff

GWR synchronisation for ebau projects

Getting started

Installation

Requirements

  • docker
  • docker-compose

After installing and configuring those, download docker-compose.yml and run the following command:

echo UID=$UID > .env

docker compose up -d

You can now access the api at http://localhost:8000/api/v1/.

Configuration

ebau-gwr is a 12factor app which means that configuration is stored in environment variables. Different environment variable types are explained at django-environ.

Common

A list of configuration options which you need to set when using ebau-gwr as a standalone service:

  • SECRET_KEY: A secret key used for cryptography. This needs to be a random string of a certain length. See more.
  • ALLOWED_HOSTS: A list of hosts/domains your service will be served from. See more.
  • DATABASE_ENGINE: Database backend to use. See more. (default: django.db.backends.postgresql)
  • DATABASE_HOST: Host to use when connecting to database (default: localhost)
  • DATABASE_PORT: Port to use when connecting to database (default: 5432)
  • DATABASE_NAME: Name of database to use (default: ebau-gwr)
  • DATABASE_USER: Username to use when connecting to the database (default: ebau-gwr)
  • DATABASE_PASSWORD: Password to use when connecting to database
App specific settings

A list of configuration options which you need to set in any case:

  • GWR_WSK_ID: This is the ID that has been assigned to you by the BfS
  • GWR_FERNET_KEY: A secret key used for encrypting the passwords in housing stat credentials. Can be generated with the generate_fernet_key command

By default, the app will talk to the GWR production API if running with ENV=production (and the test API otherwise). You can overwrite this behavior by setting

  • GWR_HOUSING_STAT_BASE_URI: base uri of GWR API, e.g. "https://www-r.housing-stat.ch/regbl/api/ech0216/2"

Contributing

Look at our contributing guidelines to start with your first contribution.

Maintenance

A few notes for maintainers can be found here.