Skip to main content

GWR synchronisation for ebau projects

Project description

ebau-gwr

!!!WIP!!!

Build Status Coverage Black

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:

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

  • 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

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ebau-gwr-0.0a0.tar.gz (13.2 kB view hashes)

Uploaded Source

Built Distribution

ebau_gwr-0.0a0-py3-none-any.whl (29.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page