circleci-public/circleci-demo-python-flask

A demo application to learn how to use CircleCI

Circulate - Demo App for CircleCI

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 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 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 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 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

---

circleci-demo-python-flask's Issues

sample config.yml job

In the job section of walkthrough, consider changing the working_directory from ~/circulate to ~/. For noobs, this is not evident since 'circulate' is not the name of the demo project.

In config.yml:

version: 2
jobs:
  build:
    working_directory: ~/<project-root>
    docker:
      - image: python:3.6.0
    steps:
      - checkout
      - run: echo "hello world"

python manage.py deploy ... error with db

on a MacOS Mojave 10.14.6

I followed Readme:
postgreSQL 9.6 (running and created database circulate)
venv activated
installed requirements.txt

python manage.py deploy --> error:
(venv) (base) Kelles-MacBook-Air-2:circleci-demo-python-flask kelleclark$ python manage.py deploy
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
Traceback (most recent call last):
File "manage.py", line 83, in
manager.run()
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/flask_script/init.py", line 412, in run
result = self.handle(sys.argv[0], sys.argv[1:])
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/flask_script/init.py", line 383, in handle
res = handle(*args, **config)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/flask_script/commands.py", line 216, in call
return self.run(*args, **kwargs)
File "manage.py", line 76, in deploy
Role.insert_roles()
File "/Users/kelleclark/Documents/CI_practice/circleci-demo-python-flask/app/models.py", line 42, in insert_roles
role = Role.query.filter_by(name=r).first()
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/orm/query.py", line 3214, in first
ret = list(self[0:1])
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/orm/query.py", line 3006, in getitem
return list(res)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/orm/query.py", line 3316, in iter
return self._execute_and_instances(context)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/orm/query.py", line 3341, in _execute_and_instances
result = conn.execute(querycontext.statement, self._params)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/base.py", line 988, in execute
return meth(self, multiparams, params)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/sql/elements.py", line 287, in _execute_on_connection
return connection._execute_clauseelement(self, multiparams, params)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/base.py", line 1107, in _execute_clauseelement
distilled_params,
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/base.py", line 1248, in _execute_context
e, statement, parameters, cursor, context
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/base.py", line 1466, in _handle_dbapi_exception
util.raise_from_cause(sqlalchemy_exception, exc_info)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/util/compat.py", line 383, in raise_from_cause
reraise(type(exception), exception, tb=exc_tb, cause=cause)
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/base.py", line 1244, in _execute_context
cursor, statement, parameters, context
File "/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sqlalchemy/engine/default.py", line 552, in do_execute
cursor.execute(statement, parameters)
sqlalchemy.exc.ProgrammingError: (psycopg2.ProgrammingError) relation "roles" does not exist
LINE 2: FROM roles
^

[SQL: SELECT roles.id AS roles_id, roles.name AS roles_name, roles."default" AS roles_default, roles.permissions AS roles_permissions
FROM roles
WHERE roles.name = %(name_1)s
LIMIT %(param_1)s]
[parameters: {'name_1': 'Moderator', 'param_1': 1}]
(Background on this error at: http://sqlalche.me/e/f405)

What I did ...
It seemed like the table for roles hadnt been created...and I saw that in the testing they created some data by using

db.create_all()

so in manage.py, I added db.create:
@manager.command
def deploy():
"""Run deployment tasks."""
from flask_migrate import upgrade
from app.models import Role, User
db.create_all()

Now seems to be ok....

(venv) (base) Kelles-MacBook-Air-2:circleci-demo-python-flask kelleclark$ python manage.py deploy
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
INFO [alembic.runtime.migration] Will assume transactional DDL.
(venv) (base) Kelles-MacBook-Air-2:circleci-demo-python-flask kelleclark$ python manage.py runserver

• Serving Flask app "app" (lazy loading)
• Environment: production
  WARNING: Do not use the development server in a production environment.
  Use a production WSGI server instead.
• Debug mode: on
• Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
• Restarting with stat
• Debugger is active!
• Debugger PIN: 174-714-230

Test with multiple Python versions

As title, this issue is also mentioned on TODO section on README.

Once this issue is accepted, I can work on this and please add #orbtoberfest on this issue because of the hacktoberfest circleci :).

Heroku API Key and Forking

TL;DR: Make a note to walkthrough users that they will have to add their Heroku API Key to CircleCI before starting or the first error wont look like the walkthrough. You will get this:

if [ "${CIRCLE_BRANCH}" == "master" ]; then
  git push heroku master
  heroku run python manage.py deploy
  heroku restart
fi
Shell: /bin/bash -eo pipefail

Username for 'https://git.heroku.com': fatal: could not read Username for 'https://git.heroku.com': No such file or directory
Exited with code 128

Adding the key will get you the expected first error.

Also: When forking, make sure to change project name to not conflict on Heroku with the tutorial instance which has the 'cci-demo-walkthrough' namespace occupied.

Tests in parallel

Hey @keybits,

Are the tests running in parallel, or can we set them up to?

🙇

Fix latest failed CirCleCI build

As title, it seems that the latest CirCleCI build is failed.

And I think it should be fixed/concerned.

Once this issue is accepted, I can work on this and please add #orbtoberfest on this issue because of the hacktoberfest circleci :).