The sample python flask app here is designed to demonstrate what a typical python CI workflow may look on CircleCI.
You can see the CI pipelines for this application running live on CircleCI.
In this sample config, we have a single workflow build-and-test which will install and cache our required python packages, and then run tests with pytest, a common python testing framework. This config makes use of the Python orb, a package for CircleCI's config language, which makes writing our config shorter, and easier.
If you would like to copy the config.yml and adapt it to your project, be sure to read the comments in the config file to ensure it works for your project. For more details, see the CircleCI configuration reference.
Inside the .circleci directory, you will find an extended directory that extends the configuration beyond the default .circleci/config.yml. These configuration files are tested with every pull request to this sample app, so they stay up to date and verified working.
The .circleci/extended/heroku-deploy.yml configuration file extends the default config by adding a job to deploy to heroku via a git push. For more information on how to configure this for your own project, visit the CircleCI docs for more details
The .circleci/extended/pylint.yml configuration file extends the default config by adding a step to sample job. The .pylintrc in the project directory is configured to fail the pipeline if any errors are present when linting.
This sample application is a flask REST server written in python, and utilizes the connexion framework which allows us build and run the service from an OpenAPI/Swagger specification.
When you start up the service, you can open this page in your browser to view the available API endpoints.
CFD(Continuous Food Delivery) is a sample application that relies on a separate UI framework. If you would like to run this project locally with a complete UI, you can use a valid CFD front-end, such as one of the following sample projects:
| Language | GitHub | Description |
|---|---|---|
| Javascript (Vue.js) | Link | A Javascript Front-End for CFD |
If you would like to try this application out locally, you can find runtime instructions below.
Python 3.5.2+ OR Docker
To run the server on a Docker container, please execute the following from the root directory:
docker-compose up --buildIf not using docker, to run the server, please execute the following from the root directory:
pip3 install -r run-requirements.txt
python3 -m openapi_server
To launch the unit tests, use pytest:
pip3 install -r requirements.txt
pytest
If you want to run tests using a live database, use the alternative compose file:
docker-compose -f docker-compose-test.yml up --build --exit-code-from web
- CircleCI Docs - The official CircleCI Documentation website.
- CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have.
This repository is licensed under the MIT license. The license can be found here.