1. Create a Python virtual environment

$ python -m venv venv $ source venv/bin/activate (venv) $

2. Install the requirements

(venv) $ python -m pip install -r requirements.txt 

You can run the project with this command in your terminal:

(venv) $ uvicorn shortener_app.main:app --reload

Your server will reload automacially when you change a file.

The project provides default environment settings in shortener_app/config.py. While you can use the default settings, it's recommended to create a .env file to store your settings outside of your production code. E.g.:

# .env ENV_NAME="Development" BASE_URL="http://url.shortener" DB_URL="sqlite:///./test_database.db" 

With an .env file that contains the ENV_NAME variable with the value "Development" you can verify if your external .env file loads correctly:

>>> from shortener_app.config import get_settings >>> get_settings().env_name ... loading Settings 'Development'

To get an overview of the environment variables you can set, check the shortener_app/config.py file.

☝️ Note: You should never add the .env file to your version control system.

When the project is running you can visit the documentation in your browser:

• http://127.0.0.1:8000/docs
• http://127.0.0.1:8000/redoc

Philipp Acsany - Email: philipp@realpython.com

Distributed under the MIT license. See LICENSE in the root directory of this materials repo for more information.