{"id":20490962,"url":"https://github.com/circleci-public/circleci-demo-python-flask","last_synced_at":"2025-04-06T11:10:35.015Z","repository":{"id":18493428,"uuid":"84443026","full_name":"CircleCI-Public/circleci-demo-python-flask","owner":"CircleCI-Public","description":"A demo application to learn how to use CircleCI","archived":false,"fork":false,"pushed_at":"2024-05-20T18:29:42.000Z","size":4159,"stargazers_count":85,"open_issues_count":25,"forks_count":227,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-03-30T09:09:32.219Z","etag":null,"topics":["circleci","circleci-demos","demo","demo-app","flask","heroku","python","tutorial","walkthrough"],"latest_commit_sha":null,"homepage":"https://circleci.com/gh/CircleCI-Public/circleci-demo-python-flask","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CircleCI-Public.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-09T13:05:44.000Z","updated_at":"2024-08-09T08:54:35.000Z","dependencies_parsed_at":"2024-11-19T02:52:13.868Z","dependency_job_id":null,"html_url":"https://github.com/CircleCI-Public/circleci-demo-python-flask","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcircleci-demo-python-flask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcircleci-demo-python-flask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcircleci-demo-python-flask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CircleCI-Public%2Fcircleci-demo-python-flask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CircleCI-Public","download_url":"https://codeload.github.com/CircleCI-Public/circleci-demo-python-flask/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471521,"owners_count":20944158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circleci","circleci-demos","demo","demo-app","flask","heroku","python","tutorial","walkthrough"],"created_at":"2024-11-15T17:19:13.261Z","updated_at":"2025-04-06T11:10:34.994Z","avatar_url":"https://github.com/CircleCI-Public.png","language":"Python","readme":"# Circulate - Demo App for CircleCI\n\n[![CircleCI](https://circleci.com/gh/CircleCI-Public/circleci-demo-python-flask.svg?style=svg\u0026circle-token=6715e4f37e6b8cee04ea7f1812ac00fb135199f9)](https://circleci.com/gh/CircleCI-Public/circleci-demo-python-flask/)\n\nThis 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.\n\nIt'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 :-)\n\n**Original Author Credit:** This is directly based on Miguel Grinberg's excellent [Flasky](https://github.com/miguelgrinberg/flasky) application.\n\nThe application uses Python and Flask for the backend.\n\n**IMPORTANT:**\n\n- You **do not need to know Python to follow the guide** in the CircleCI docs.\n- 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.\n- 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.\n\n## Deployment to Heroku\n\nThe 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.\n\n## Running locally\n\n**Note:** As mentioned above you don't need to run this application locally to learn about using CircleCI.\n\n- Install PostgreSQL (tested with 9.6.5)\n- Install Python (tested with Python 3.6.2)\n- Fork or clone this repository\n- Create and activate a virtual environment\n- Enter the following commands:\n\n```\ncreatedb circulate\npip install -r requirements/dev.txt\npython manage.py deploy\npython manage.py runserver\n```\n\nYou can now test the app locally with the Flask development server.\n\n## Tests\n\nThe app runs various tests:\n\n- unit tests for database models (using unittest)\n- unit tests for client view functions (using Flask Test Client)\n- unit tests for the API (using Flask Test Client)\n- integration tests for logging in etc (using Selenium and ChromeDriver)\n\nIt uses [unittest-xml-reporting](https://github.com/xmlrunner/unittest-xml-reporting) for JUNIT style report generation.\n\nSee the `tests` directory for details.\n\n`python manage.py test` to run the tests locally.\n\n\n## TODO\n\n- add parallelization\n- test with multiple python versions\n- run with coverage on CircleCI\n- make email testing work on CircleCI with mailhog\n- make email work on the deployed Heroku app\n\n---\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fcircleci-demo-python-flask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcircleci-public%2Fcircleci-demo-python-flask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-public%2Fcircleci-demo-python-flask/lists"}