Skip to content

Commit

Permalink
#70: Update running instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
keiranjprice101 committed Oct 15, 2019
1 parent 5bb9cf2 commit bc34eb9
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@
ICAT API to interface with the Data Gateway

## Contents
+ [Requirements](#requirements)
+ [Setup](#setup-and-running-the-api)
+ [Project structure](#project-structure)
+ [Main](#main)
+ [Endpoints](#endpoints)
+ [Mapped Classes](#mapped-classes)
- [datagateway-api](#datagateway-api)
- [Contents](#contents)
- [Requirements](#requirements)
- [Setup and running the API](#setup-and-running-the-api)
- [Project structure](#project-structure)
- [Main:](#main)
- [Endpoints:](#endpoints)
- [Mapped classes:](#mapped-classes)
- [Database Generator](#database-generator)
- [Running Tests](#running-tests)



Expand Down Expand Up @@ -46,9 +50,10 @@ PowerShell
> $env:FLASK_APP = "src/main.py"
> flask run
```

More information can be found [here](http://flask.pocoo.org/docs/1.0/cli/)

Alternatively the api can be run with `python -m src.main`

By default the api will run on `http://localhost:5000` and all requests are made here

Expand Down Expand Up @@ -127,7 +132,7 @@ By default it will generate 20 years worth of data (approx 70,000 entities). The
`random` and `Faker` and is seeded with a seed of 1. The seed and number of years of data generated can
be changed by using the arg flags `-s` or `--seed` for the seed, and `-y` or `--years` for the number of years.
For example:
`python util/icat_db_generator.py -s 4 -y 10` Would set the seed to 4 and generate 10 years of data.
`python -m util.icat_db_generator -s 4 -y 10` Would set the seed to 4 and generate 10 years of data.

## Running Tests
To run the tests use `python -m unittest discover`
Expand Down

0 comments on commit bc34eb9

Please sign in to comment.