The aim of this workshop is to introduce you to FastAPI, Redis and Docker.
After an introduction to these technologies (which will be mostly about FastAPI and Redis), you will be introduced to a skeleton project (contained in this repository).
We will work together to implement some features, that I have completely removed before the workshop.
I have also prepared a frontend client for the FastAPI application, so the workshop can be more interactive.
The target API specification is available here.
This project also contains a pytest suite which covered 95% of the original source code, including a websocket which can't be included in the OpenAPI specification.
First, you need to install the tools required, which are Docker and Docker Compose. If you don't have them already, please install them before the workshop
After installing Docker, please clone this repo:
git clone https://github.com/mRokita/pycon-fastapi-workshop
cd pycon-fastapi-workshop
After cloning the repo, test if everything works by running sudo docker compose up --build.
Open http://localhost:8081/ in your browser and make sure that value of the "API URL" text field is green (see the picture attached).
Don't worry if the app does not work - most backend features have been removed on purpose.
You can run tests with docker compose exec backend pytest.
Don't worry if most of them fail - during the workshop it will be our job to make them pass.
You will need Python 3.7+, although 3.10 is recommended and is the only version that I've tested.
Poetry is required to install project dependencies (https://python-poetry.org/docs/#installation).
By default, Poetry automatically creates a virtualenv, so it is enough to run the following commands:
# Commands relative to project root
cd pycon-chat
poetry install
poetry run python -m pycon_chat
If you want to run the frontend, which is based on the Svelte framework,
the only thing that you need is npm.
To install all the dependencies, you just need to run the following commands:
# Commands relative to project root
cd frontend
npm install
npm run dev
Make sure that both frontend & backend servers are running.
Open frontend in your browser, and make sure that value of the "API URL" text field is green (see the picture attached).
To run tests, execute make test from the pycon-chat directory.
In the middle of the workshop, you will also need to use Redis, which is very easy to install on most platforms - see https://redis.io/docs/getting-started/.