Skip to content

Commit

Permalink
Updated README install instructions for Installation (development) by…
Browse files Browse the repository at this point in the history
… adding

missing default constants for EXCLUDE_APPS and others. Without these getting
setup locally fails.
  • Loading branch information
chrisjsimpson committed Dec 20, 2018
1 parent aed1194 commit b744857
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,24 @@ $ virtualenv --python=python3 ../venv
$ source ../venv/bin/activate
(venv)$ pip install -r requirements.txt
```
Note: if this fails you may be missing the `python3-tk` and `tk` packages:

```bash
$ sudo apt install python3-tk tk
```

## Configure settings

Create and edit `apimanager/apimanager/local_settings.py`:

```python
import os
BASE_DIR = '/your/base/dir'
EXCLUDE_APPS = []
EXCLUDE_FUNCTIONS = []
EXCLUDE_URL_PATTERN = []
API_EXPLORER_APP_NAME = 'API Explorer app name'
API_DATEFORMAT = '%Y-%m-%dT%H:%M:%S.%fZ'
# Used internally by Django, can be anything of your choice
SECRET_KEY = '<random string>'
# API hostname, e.g. https://api.openbankproject.com
Expand Down

0 comments on commit b744857

Please sign in to comment.