mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-24 09:21:39 -05:00
d1826af3c7
In response to: https://github.com/alphagov/notifications-api/pull/3332#issuecomment-921897641 These were so out-of-date as to be misleading. We can always refer back to them in the version history if needed.
124 lines
3.5 KiB
Markdown
124 lines
3.5 KiB
Markdown
# GOV.UK Notify API
|
|
|
|
Contains:
|
|
- the public-facing REST API for GOV.UK Notify, which teams can integrate with using [our clients](https://www.notifications.service.gov.uk/documentation)
|
|
- an internal-only REST API built using Flask to manage services, users, templates, etc (this is what the [admin app](http://github.com/alphagov/notifications-admin) talks to)
|
|
- asynchronous workers built using Celery to put things on queues and read them off to be processed, sent to providers, updated, etc
|
|
|
|
## Setting Up
|
|
|
|
### Python version
|
|
|
|
At the moment we run Python 3.6 in production. You will run into problems if you try to use Python 3.5 or older, or Python 3.7 or newer.
|
|
|
|
### AWS credentials
|
|
|
|
To run the API you will need appropriate AWS credentials. See the [Wiki](https://github.com/alphagov/notifications-manuals/wiki/aws-accounts#how-to-set-up-local-development) for more details.
|
|
|
|
### `environment.sh`
|
|
|
|
Creating and edit an environment.sh file.
|
|
|
|
```
|
|
echo "
|
|
export NOTIFY_ENVIRONMENT='development'
|
|
|
|
export MMG_API_KEY='MMG_API_KEY'
|
|
export FIRETEXT_API_KEY='FIRETEXT_ACTUAL_KEY'
|
|
export NOTIFICATION_QUEUE_PREFIX='YOUR_OWN_PREFIX'
|
|
|
|
export FLASK_APP=application.py
|
|
export FLASK_ENV=development
|
|
export WERKZEUG_DEBUG_PIN=off
|
|
"> environment.sh
|
|
```
|
|
|
|
Things to change:
|
|
|
|
* Replace `YOUR_OWN_PREFIX` with `local_dev_<first name>`.
|
|
* Run the following in the credentials repo to get the API keys.
|
|
|
|
```
|
|
notify-pass credentials/providers/api_keys
|
|
```
|
|
|
|
### Postgres
|
|
|
|
Install [Postgres.app](http://postgresapp.com/).
|
|
|
|
Currently the API works with PostgreSQL 11. After installation, open the Postgres app, open the sidebar, and update or replace the default server with a compatible version.
|
|
|
|
**Note:** you may need to add the following directory to your PATH in order to bootstrap the app.
|
|
|
|
```
|
|
export PATH=${PATH}:/Applications/Postgres.app/Contents/Versions/11/bin/
|
|
```
|
|
|
|
### Redis
|
|
|
|
To switch redis on you'll need to install it locally. On a OSX we've used brew for this. To use redis caching you need to switch it on by changing the config for development:
|
|
|
|
REDIS_ENABLED = True
|
|
|
|
|
|
## To run the application
|
|
|
|
```
|
|
# install dependencies, etc.
|
|
make bootstrap
|
|
|
|
# run the web app
|
|
make run-flask
|
|
|
|
# run the background tasks
|
|
make run-celery
|
|
|
|
# run scheduled tasks (optional)
|
|
make run-celery-beat
|
|
```
|
|
|
|
## To test the application
|
|
|
|
```
|
|
# install dependencies, etc.
|
|
make bootstrap
|
|
|
|
make test
|
|
```
|
|
|
|
## To update application dependencies
|
|
|
|
`requirements.txt` file is generated from the `requirements-app.txt` in order to pin
|
|
versions of all nested dependencies. If `requirements-app.txt` has been changed (or
|
|
we want to update the unpinned nested dependencies) `requirements.txt` should be
|
|
regenerated with
|
|
|
|
```
|
|
make freeze-requirements
|
|
```
|
|
|
|
`requirements.txt` should be committed alongside `requirements-app.txt` changes.
|
|
|
|
|
|
## To run one off tasks
|
|
|
|
Tasks are run through the `flask` command - run `flask --help` for more information. There are two sections we need to
|
|
care about: `flask db` contains alembic migration commands, and `flask command` contains all of our custom commands. For
|
|
example, to purge all dynamically generated functional test data, do the following:
|
|
|
|
Locally
|
|
```
|
|
flask command purge_functional_test_data -u <functional tests user name prefix>
|
|
```
|
|
|
|
On the server
|
|
```
|
|
cf run-task notify-api "flask command purge_functional_test_data -u <functional tests user name prefix>"
|
|
```
|
|
|
|
All commands and command options have a --help command if you need more information.
|
|
|
|
## Further documentation
|
|
|
|
- [Writing public APIs](docs/writing-public-apis.md)
|