andaqu / big5-app

Python server using Flask, deployment to Heroku. Thesis side-project.

big5-app

08/03: Despite content may change, this README might not get updated.

This is my attempt at setting up a development and production server/database using Python, Flask and Heroku. There is a number of things I find worth documenting. This was a undergrad thesis side-project, mostly to centralise operations.

Folder directory structure

big5-app
├── config
├── migrations
├── server
│   ├── __init.py__
│   ├── ext.py
│   ├── main.py
│   └── models.py
├── .env (*)
├── .flaskenv
├── Pipfile
├── Procfile
├── requirements.txt
└── runtime.txt

(*) not included in repository. Should include a one-liner: SQLALCHEMY_DATABASE_URI_DEBUG = #

• config.py: Config files for development and production. The development config file retrieves the database URI from .env, but the production config file retrieves the database URI from Heroku's set environment variable.
• migrations: Folder to store database's migrations
• server:
  • __init.py__: Flask application factory
  • ext.py: Initialises a common DB instance
  • main.py: Flask blueprint for endpoints
  • models.py: Database models
• .env: Details local database URI, needs python-dotenv library.
• .flaskenv: Details Flask enviornment variables: FLASK_APP and FLASK_ENV. Both are for development, as these are handeled in other places for production.
• Pipfile: pipenv's virtual environment requirements folder.
• Procfile: command line for starting the application on heroku.
• requirements.txt: standard requirements.txt file, can be derived from pipenv: pipenv run pip freeze > requirements.txt.
• runtime.txt: states utilisied Python version, Heroku needs to know this.

Useful commands

I won't explain why as I honestly won't bother. But I may need a reminder in the future...

pipenv install #
pipenv shell
pipenv run pip freeze > requirements.txt
pipenv sync
flask run
flask db init
flask db migrate
flask db upgrade
flask db stamp head
heroku login
heroku create #
heroku git:remote -a #
heroku config:set FLASK_ENV=production
heroku config --app #
heroku logs --tail
heroku run flask db upgrade
heroku pg:info # -a #
heroku pg:psql
heroku plugins:install java
git push heroku HEAD:master
psql -U postgres
\copy public."Word" FROM 'data/words.csv' DELIMITER ',' CSV HEADER;
\copy personality."User" FROM 'data/personality.User.csv' DELIMITER ',' CSV HEADER;
\copy personality."Document" FROM 'data/personality.Document.csv' DELIMITER ',' CSV HEADER;
\copy twitter."User" FROM 'data/twitter.User.csv' DELIMITER ',' CSV HEADER;
\copy twitter."Document" FROM 'data/twitter.Document.csv' DELIMITER ',' CSV HEADER;
\copy (SELECT d.features, u.o FROM personality."User" u INNER JOIN personality."Document" d ON u.id = d.id) TO 'export/o.csv' WITH CSV;
\copy (SELECT d.features, u.c FROM personality."User" u INNER JOIN personality."Document" d ON u.id = d.id) TO 'export/c.csv' WITH CSV;
\copy (SELECT d.features, u.e FROM personality."User" u INNER JOIN personality."Document" d ON u.id = d.id) TO 'export/e.csv' WITH CSV;
\copy (SELECT d.features, u.a FROM personality."User" u INNER JOIN personality."Document" d ON u.id = d.id) TO 'export/a.csv' WITH CSV;
\copy (SELECT d.features, u.n FROM personality."User" u INNER JOIN personality."Document" d ON u.id = d.id) TO 'export/n.csv' WITH CSV;
\copy (SELECT u.id, u.o, u.c, u.e, u.a, u.n FROM twitter."User" u INNER JOIN twitter."Document" d ON u.id = d.id WHERE u.o IS NOT NULL AND d.wc >= 200) TO 'export/twitter_personality.csv' WITH CSV;