ataxya/CICD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Alan Pryor 2019-08-03 12:58:39 -04:00
parent 803c53a605
commit 3b636d8a29
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,4 +1,6 @@
# flask_api_example # Example of a scalable Flask API
This is an example project using the structure propsed in [this blog post](http://alanpryorjr.com/2019-05-20-flask-api-example/)
A sample project showing how to build a scalable, maintainable, modular Flask API with a heavy emphasis on testing. A sample project showing how to build a scalable, maintainable, modular Flask API with a heavy emphasis on testing.
@ -34,3 +36,12 @@ python wsgi.py
``` ```
Navigate to the posted URL in your terminal to be greeted with Swagger, where you can test out the API. Navigate to the posted URL in your terminal to be greeted with Swagger, where you can test out the API.
## Running tests
To run the test suite, simply pip install it and run from the root directory like so
```
pip install pytest
pytest
```