ebau-gwr
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 BfSGWR_FERNET_KEY: A secret key used for encrypting the passwords in housing stat credentials. Can be generated with thegenerate_fernet_keycommand
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.
Release files for ebau-gwr 0.8.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ebau_gwr-0.8.4.tar.gz | 27.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ebau_gwr-0.8.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 61.3 kB
Release files / ebau_gwr-0.8.4.tar.gz
| Download URL | ebau_gwr-0.8.4.tar.gz |
|---|---|
| Size | 27.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
850bdd62df180ab80df1043ba81121e08cbfbccc9057a3b29cfa7a7aab46aadb
|
|
BLAKE2b-256 checksum How to use checksums |
e7ff59f11046fea217ecaf867a69771af2916a59998d82cd000985cd040f3d54
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / ebau_gwr-0.8.4-py3-none-any.whl
| Download URL | ebau_gwr-0.8.4-py3-none-any.whl |
|---|---|
| Size | 33.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
55c3a37317301f1cc336114545b7bb7ae06ce0a814b4c6d1fc19985b809799e8
|
|
BLAKE2b-256 checksum How to use checksums |
194321488e97b635d02aaa7b843f3590f2ebeb1b8229aef08bccb2059036df0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Security for ebau-gwr 0.8.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
