Environment:
- Python v3.10.7
-
Python 3.10
This example uses
|
operator on type annotations (PEP 604). -
Python 3.8
This example uses
:=
(Walrus) operator on file chunked reading (PEP 572).
-
Create Python virtual environment.
python -m venv py310venv
-
Activate the Python virtual environment.
source py310venv/bin/activate
-
Upgrade
pip
and install dependencies.python -m pip install --no-cache-dir --upgrade pip python -m pip install --no-cache-dir --upgrade -r requirements.txt
Get into src/fastapi_app
folder and run python main.py
.
To run in development mode, set MODE
environment variable to dev
and run
app:
MODE="dev" python main.py
In this mode, it will reload automatically if you save the changes to files in
src/fastapi_app
folder.
To enable file logger, change logger.enable
to true
in
src/fastapi_app/configs/settings.json
file.
The log files will be put in src/fastapi_app/logs
folder.
To change the location to place log files, change logger.path
in
src/fastapi_app/configs/settings.json
file.
To change the log level of default console logger, set LOGURU_LEVEL
environment variable, e.g. set it to INFO
:
LOGURU_LEVEL="INFO" python main.py
# or if using Docker containers:
docker run -e LOGURU_LEVEL="INFO" -p 3001:3001 -d example-fastapi
To disable the default console logger, change the following lines in
src/fastapi_app/main.py
file:
if settings.logger is not None:
logger_util.setup_logger(settings.logger, True)
The examples below use example-fastapi
as the image name.
To build a Docker image:
docker build -t example-fastapi .
Run a container (the default port is 3001
):
docker run -p 3001:3001 -d example-fastapi
To build a Docker image that only contains environment:
docker build -t example-fastapi:env-only -f Dockerfile.env_only .
Run a container:
docker run -p 3001:3001 -v ./src:/ws/src -d example-fastapi:env-only
-
isort sorts imports in wrong order.
Refer to Wrong order in import when using sort imports in vscode #14254
Solution: Add
.vscode/settings.json
to your workspace:{ "isort.args": [ "--src=${workspaceFolder}/src/fastapi_app" ] }
-
Browser doesn't reflect changes made in the files in
client
folder.Browser might cache the content before changes made.
To disable browser caching, open the developer tools (press the
F12
key generally) and get into Network tab then check Disable cache checkbox.Now refresh the website, it should reflect changes.