Project Requirements

Python Dependencies

Below is the current list of Python dependencies for this project:

alembic>=1.13.2,<2.0.0
bcrypt>=4.2.0,<5.0.0
colorama>=0.4.6,<1.0.0
fastapi>=0.111.1,<1.0.0
google-api-python-client>=2.88.0,<3.0.0
httpx>=0.27.0,<1.0.0
openai>=1.37.0,<2.0.0
pydantic>=2.8.2,<3.0.0
python-dotenv>=1.0.1,<2.0.0
python-jose[cryptography]>=3.3.0,<4.0.0
python-multipart>=0.0.9,<0.1.0
sqlalchemy>=2.0.31,<3.0.0
starlette>=0.37.2,<1.0.0
uvicorn>=0.30.3,<1.0.0
youtube_transcript_api>=0.6.2,<1.0.0
psycopg2

-r requirements-dev.txt

The requirements specifically for development purporses are:

black>=24.8.0,<25.0.0
isort>=5.13.2,<6.0.0
pytest>=8.3.1,<9.0.0

Other Requirements

Environment variables are supplied by .env. As a template, here is .env.example which shows the necessary values to supply to the application.

OPENAI_API_KEY=your_openai_api_key_here
YOUTUBE_API_KEY=your_youtube_api_key_here
SECRET_KEY=your_secret_key_here
PROJECT_DIR=/path/to/your/project
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
POSTGRES_DB=your_db_name
POSTGRES_USER=your_db_user
POSTGRES_PASSWORD=your_db_password
DATABASE_URL=postgresql://your_db_user:your_db_password@postgres/your_db_name
USER_REPOSITORY_TYPE=postgres