Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circleci-public/circleci-demo-python-flask
A demo application to learn how to use CircleCI
https://github.com/circleci-public/circleci-demo-python-flask
circleci circleci-demos demo demo-app flask heroku python tutorial walkthrough
Last synced: about 2 hours ago
JSON representation
A demo application to learn how to use CircleCI
- Host: GitHub
- URL: https://github.com/circleci-public/circleci-demo-python-flask
- Owner: CircleCI-Public
- License: mit
- Created: 2017-03-09T13:05:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T13:14:26.000Z (over 1 year ago)
- Last Synced: 2024-03-16T09:21:43.008Z (8 months ago)
- Topics: circleci, circleci-demos, demo, demo-app, flask, heroku, python, tutorial, walkthrough
- Language: Python
- Homepage: https://circleci.com/gh/CircleCI-Public/circleci-demo-python-flask
- Size: 3.97 MB
- Stars: 85
- Watchers: 29
- Forks: 226
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Circulate - Demo App for CircleCI
[](https://circleci.com/gh/CircleCI-Public/circleci-demo-python-flask/)
This is a working application that you can use to learn how to build, test and deploy with CircleCI 2.0. Follow the [Project Walkthrough](https://circleci.com/docs/2.0/project-walkthrough/) guide here.
It's a 'social blogging' web application similar to Twitter. Users can create accounts, make posts, follow users and comment on posts. You can *circualate* your thoughts and ideas :-)
**Original Author Credit:** This is directly based on Miguel Grinberg's excellent [Flasky](https://github.com/miguelgrinberg/flasky) application.
The application uses Python and Flask for the backend.
**IMPORTANT:**
- You **do not need to know Python to follow the guide** in the CircleCI docs.
- You will not need to install or setup a Python environment to follow the tutorial - you can follow along by making edits to config on GitHub if you wish.
- No matter what language or stack you are going to use with CircleCI, we recommend following the walkthrough first, as it introduces concepts about CircleCI that you can then apply to your own project.
## Deployment to Heroku
The application demonstrates how to deploy to Heroku from CircleCI 2.0. Please consult the [Project Walkthrough](https://circleci.com/docs/2.0/project-walkthrough/) for documentation on how this works.
## Running locally
**Note:** As mentioned above you don't need to run this application locally to learn about using CircleCI.
- Install PostgreSQL (tested with 9.6.5)
- Install Python (tested with Python 3.6.2)
- Fork or clone this repository
- Create and activate a virtual environment
- Enter the following commands:
```
createdb circulate
pip install -r requirements/dev.txt
python manage.py deploy
python manage.py runserver
```
You can now test the app locally with the Flask development server.
## Tests
The app runs various tests:
- unit tests for database models (using unittest)
- unit tests for client view functions (using Flask Test Client)
- unit tests for the API (using Flask Test Client)
- integration tests for logging in etc (using Selenium and ChromeDriver)
It uses [unittest-xml-reporting](https://github.com/xmlrunner/unittest-xml-reporting) for JUNIT style report generation.
See the `tests` directory for details.
`python manage.py test` to run the tests locally.
## TODO
- add parallelization
- test with multiple python versions
- run with coverage on CircleCI
- make email testing work on CircleCI with mailhog
- make email work on the deployed Heroku app
---