If you are using GitPod for the project exercise (i.e. you cannot use your local machine) then you'll want to launch a VM using the following link. Note this VM comes pre-setup with Python & Poetry pre-installed.
The project uses poetry for Python to create an isolated environment and manage package dependencies. To prepare your system, ensure you have an official distribution of Python version 3.8+ and install Poetry using one of the following commands (as instructed by the poetry documentation):
curl -sSL https://install.python-poetry.org | python3 -(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -You can check poetry is installed by running poetry --version from a terminal.
Please note that after installing poetry you may need to restart VSCode and any terminals you are running before poetry will be recognised.
The project uses a virtual environment to isolate package dependencies. To create the virtual environment and install required packages, run the following from your preferred shell:
$ poetry installYou'll also need to clone a new .env file from the .env.template to store local configuration options. This is a one-time operation on first setup:
$ cp .env.template .env # (first time only)Populate the .env file with the relevant values for:
- TRELLO_API_KEY
- TRELLO_API_TOKEN
- BOARD_ID
- LIST_ID
For now the trello board needs to have labels created with the values:
- Not Started
- In Progress
- Complete
n.b. potential future intention to ensure these are created on app startup and possibly even insert their ids dynamically into the env at that point
The .env file is used by flask to set environment variables when running flask run. This enables things like development mode (which also enables features like hot reloading when you make a file change). There's also a SECRET_KEY variable which is used to encrypt the flask session cookie.
Once the all dependencies have been installed, start the Flask app in development mode within the Poetry environment by running:
$ poetry run flask runYou should see output similar to the following:
* Serving Flask app 'todo_app/app'
* Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
* Running on http://127.0.0.1:5000
Press CTRL+C to quit
* Restarting with stat
* Debugger is active!
* Debugger PIN: 113-666-066Now visit http://localhost:5000/ in your web browser to view the app.
Running the tests is as simple as:
poetry run pytest or simply pytest from within the project virtual environment
For instructions on running the app on virtual machines in the cloud, consult the readme in the ansible directory