Skip to content

Latest commit

 

History

History
78 lines (58 loc) · 3.33 KB

README.md

File metadata and controls

78 lines (58 loc) · 3.33 KB

directory-sso-proxy

code-climate-image circle-ci-image codecov-image gitflow-image calver-image


Development

Installing

$ git clone https://github.com/uktrade/directory-sso-proxy
$ cd directory-sso-proxy
$ virtualenv .venv -p python3.6.12
$ source .venv/bin/activate
$ make requirements
$ make install_requirements

Getting started

$ make webserver

Requirements

Python 3.9.2

Postgres

Redis

Configuration

Secrets such as API keys and environment specific configurations are placed in conf/env/secrets-do-not-commit - a file that is not added to version control. To create a template secrets file with dummy values run make secrets.

Commands

Command Description
make clean Delete pyc files
make pytest Run all tests
make pytest test_foo.py Run all tests in file called test_foo.py
make pytest -- --last-failed Run the last tests to fail
make pytest -- -k foo Run the test called foo
make pytest -- Run arbitrary pytest command
make manage Run arbitrary management command
make webserver Run the development web server
make requirements Compile the requirements file
make install_requirements Installed the compile requirements file
make secrets Create your secret env var file
make flake8 Run flake8 linting
make checks Run black, isort, flake8 in check mode
make autoformat Run black and isort in file-writing mode

Helpful links

Related projects:

https://github.com/uktrade?q=directory https://github.com/uktrade?q=great