Initial commit

.envrc

@@ -0,0 +1,31 @@
+# Environment variables go here, and can be read in by Python using `os.getenv`:
+#
+#   --------------------------------------------------------
+#   import os
+#
+#   # Example variable
+#   EXAMPLE_VARIABLE = os.getenv("EXAMPLE_VARIABLE")
+#   --------------------------------------------------------
+#
+# To ensure the `sed` command below works correctly, make sure all file paths in environment variables are absolute,
+# are relative but do not reference any other variables except `$(pwd)`.
+#
+# DO NOT STORE SECRETS HERE - this file is version-controlled! You should store secrets in a `.secrets` file, which is
+# not version-controlled - this can then be sourced here, using `source_env ".secrets"`.
+
+# Extract the variables to `.env` if required. Note `.env` is NOT version-controlled, so `.secrets` will not be
+# committed. Use the first line if a `.secrets` file exists, otherwise use the second line
+# sed -n 's/^export \(.*\)$/\1/p' .envrc .secrets | sed -e 's?$(pwd)?'"$(pwd)"'?g' > .env
+sed -n 's/^export \(.*\)$/\1/p' .envrc | sed -e 's?$(pwd)?'"$(pwd)"'?g' > .env
+
+# Add the working directory to PYTHONPATH
+export PYTHONPATH="$PYTHONPATH:$(pwd)"
+
+# Import secrets from an untracked file `.secrets`
+# source_env ".secrets"
+
+# Add environment variables for the `docs` directory
+export DIR_DOCS=$(pwd)/docs
+
+# Add environment variables for the `tests` directory
+export DIR_TESTS=$(pwd)/tests

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+# Rule definitions: http://flake8.pycqa.org/en/latest/user/error-codes.html
+# D203: 1 blank line required before class docstring
+# W503: line break before binary operator
+exclude = venv*,__pycache__,node_modules,bower_components,migrations
+ignore = D203,W503
+max-complexity = 9
+max-line-length = 120

.github/pull_request_template.md

@@ -0,0 +1,29 @@
+# Summary
+
+Add your summary here - keep it brief, to the point, and in plain English. For further information about pull requests,
+check out the [GDS Way][gds-way].
+
+# Checklists
+
+<!--
+These are DO-CONFIRM checklists; it CONFIRMs that you have DOne each item.
+
+Outstanding actions should be completed before reviewers are assigned; if actions are irrelevant, please try and add a
+comment stating why.
+
+Incomplete pull/merge requests MAY be blocked until actions are resolved, or closed at the reviewers' discretion.
+-->
+
+This pull/merge request meets the following requirements:
+
+- [ ] Code runs
+- [ ] Developments are **secure** and [**ethical**][data-ethics-framework]
+- [ ] You have made proportionate checks that the code works correctly, and the theme works as expected
+- [ ] Test suite passes
+- [ ] [Minimum usable documentation][agilemodeling] written in the `docs` folder
+
+Comments have been added below around the incomplete checks.
+
+[agilemodeling]: http://agilemodeling.com/essays/documentLate.htm
+[data-ethics-framework]: https://www.gov.uk/government/publications/data-ethics-framework
+[gds-way]: https://gds-way.cloudapps.digital/standards/pull-requests.html