Podcasts Service

Backend Service which can be used for creation a custom podcasts (sets of episodes) based on fetched public media resources.
This project provides a backend (API service) and is positioned as an updated version of podcast application.

Content

• Project Description
• Install Project
• Run Project
• Useful Commands
• Env Variables
• License

Project Description

Target

This application can be used for creation your podcasts.
If you have any sounds (or YouTube videos as example) which you want to listen later, you can create podcast (via web interface) and attach your tracks to it
Created podcast (with prepared episodes) will have a direct link (to RSS feed), which can be used for adding your podcast to same podcast application (Add by URL)
Adding and downloading each new episodes will refresh RSS-feed and your APP will be able to get them.

Tech Stack

• python 3.12
• Starlette
• RQ (background tasks)
• yt-dlp (download audio tracks from external media platforms)
• redis (key-value storage + RQ)
• ffmpeg (audio postprocessing)

Tech details

Technically project contains from 3 parts:

Starlette API service (run on APP_PORT from your env):

• AUTH service (JWT-based)
• PODCAST service (CRUD API for podcasts/episodes)
• Some tools and engines for fetching episodes from external resources (YouTube as for now)

Media storage (S3):

• episodes
• generated RSS feeds

Background application: RQ

• download sounds from requested resource
• perform sound and prepare mp3 files with ffmpeg
• generate RSS feed file (xml) with episodes (by specification https://cyber.harvard.edu/rss/rss.html)

Install Project

Prepare virtual environment

cd "<PATH_TO_PROJECT>"
cp .env.template .env
# update variables to actual (redis, postgres, etc.)

Prepare extra resources (postgres | redis)

export $(cat .env | grep -v ^# | xargs)
docker run --name postgres-etc -e POSTGRES_PASSWORD=${DATABASE_PASSWORD} -d postgres:10.11
docker run --name redis-etc -d redis

Create database

export $(cat .env | grep -v ^# | xargs)
PGPASSWORD=${DATABASE_PASSWORD} psql -U${DATABASE_USER} -h${DATABASE_HOST} -p${DATABASE_PORT} -c "create database ${DATABASE_NAME};"

Apply migrations

cd "<PATH_TO_PROJECT>" && make migrate

Run Project

• Run via docker-containers (like in production mode)

  cd "<PATH_TO_PROJECT>" && docker-compose up --build

• Run in develop-mode

  # install pipenv https://pypi.org/project/pipenv/
  cd "<PATH_TO_PROJECT>"
  pipenv install --dev
  make run_web
  # or 
  make run_rq

Useful commands

• work with migrations

  
  make migrations_create_auto   # auto-creation
  make migrations_create_manual # manual-creation
  make migrate       # apply all migrations
  make downgrade     # unapply with param `revision=1231`
  make migrations    # show applied migrations

+ Run tests
```shell script
cd "<PATH_TO_PROJECT>"/src && pytest 

• Apply formatting (black) and lint code (pylint)

  make lint

Environment Variables

REQUIRED Variables

OPTIONAL Variables

License

This product is released under the MIT license. See LICENSE for details.