Skip to content

Commit

Permalink
#165: Make small formatting changes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
MRichards99 committed Nov 2, 2020
1 parent 4077f10 commit b4aa172
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ ICAT API to interface with the Data Gateway
The recommended development environment for this API has taken lots of inspiration from
the [Hypermodern Python](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/)
guide found online. It is assumed the commands shown in this part of the README are
executed in the root directory of this repo.
executed in the root directory of this repo once it has been cloned to your local
machine.

### pyenv (Python Version Management)
To start, install [pyenv](https://github.com/pyenv/pyenv). There is a Windows version of
Expand Down Expand Up @@ -154,8 +155,7 @@ Currently, the following Nox sessions have been created:
To make use of Git's ability to run custom hooks, [pre-commit](https://pre-commit.com/)
is used. Like Nox, Pip is used to install this tool:

```
bash
```bash
pip install --user --upgrade pre-commit
```

Expand Down Expand Up @@ -285,8 +285,6 @@ inherit two methods `to_dict()` and `update_from_dict(dictionary)`, both used fo
and updating them, in a form easily converted to JSON.




## Database Generator
There is a tool to generate mock data into the database. It is located in `util/icat_db_generator.py`
By default it will generate 20 years worth of data (approx 70,000 entities). The script makes use of
Expand All @@ -311,7 +309,6 @@ sending a post request to `/sessions/`
All endpoint methods that require a session id are decorated with `@requires_session_id`



#### Generating the swagger spec: `openapi.yaml`
The swagger generation script is located in `/src/swagger/swagger_generator.py`. The script will only run when
the config option `generate_swagger` is set to true in `config.json`. The generator decorates the first endpoint
Expand Down

0 comments on commit b4aa172

Please sign in to comment.