README.md

API

Install

1. Create virtual environment and activate:

   python -m venv .venv \
   && source .venv/bin/activate \
   && pip install -U pip wheel

2. Install package

   pip install -e api -r api/requirements.txt

   Or with optional dev dependencies:

   pip install -e "api[dev]" -r api/requirements.txt -r api/requirements_dev.txt

API Key for TMDB

1. Register for and verify an account.
2. Log into your account.
3. Select the API section on account settings.
4. Click on the link to generate a new API key and follow the instructions.

Copy the .env.example into a new .env file

Edit the file and enter your API token.

Run

uvicorn app.api:app --reload

Visit the OpenAPI docs at https://localhost:8000/docs

Developer Notes

Manage Dependencies

Dependencies are specified in pyproject.toml and managed with pip-tools.

1. Install pip-tools (globally with pipx or in local virtual environment with pip)

2. Generate lock files:

   cd api \
   && pip-compile --output-file=requirements.txt pyproject.toml --quiet \
   && pip-compile --extra=dev --output-file=requirements_dev.txt pyproject.toml --quiet \
   && cd ..

To upgrade a dependency, pass the --upgrade-package flag along with the name of the package, or to upgrade all packages, pass the --upgrade flag to the command.

More information at: https://github.com/jazzband/pip-tools/

VSCode Config

Since our python app is in api/ directory, isort has trouble finding it.

Pass the src config into the isort arguments.

{
  "isort.args": ["--profile", "black", "--src", "api"]
}

Testing

pytest api