Swagger documentation for a flask API application
- Clone repo
- create and change into directory
- Set Flask environment (ps: check the
config.py
file)
FLASK_ENV=default
uses sqliteFLASK_ENV=postgres
uses postgres db
- set virtualenv with
pipenv --three
- Install with
pipenv install
Deployed documentation version: https://waweru.pythonanywhere.com/api-docs/
- run
pipenv shell
to shart virtualenv - run:
python run.py
serving point of the API - app running on
http://127.0.0.1:5000/
- Documentation being served on
/api-docs
endpoint
pipenv run pytest
This repo is built following a tutorial published on CircleCI blog under the CircleCI Guest Writer Program.
- Blog post: Automating Flask Deployments With PythonAnywhere
- Author's GitHub profile: Waweru Mwaura
Join a team of freelance writers and write about your favorite technology topics for the CircleCI blog. Read more about the program here.
Reviewers: Ron Powell, Stanley Ndagi, Amos Omondi