Turn YouTube videos into articles!
Go to file
Evan Reichard 2df278df40
continuous-integration/drone/push Build is passing Details
[add] favicon
2023-11-25 19:24:14 -05:00
vreader [add] favicon 2023-11-25 19:24:14 -05:00
.drone.yml [add] drone cicd 2023-11-10 21:18:35 -05:00
.envrc Initial Commit 2023-11-10 21:11:44 -05:00
.gitignore Initial Commit 2023-11-10 21:11:44 -05:00
Dockerfile Initial Commit 2023-11-10 21:11:44 -05:00
LICENSE Initial Commit 2023-11-10 21:11:44 -05:00
MANIFEST.in [fix] slight refactor 2023-11-12 16:09:56 -05:00
Makefile [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00
README.md [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00
banner.png [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00
banner.xcf [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00
pyproject.toml Initial Commit 2023-11-10 21:11:44 -05:00
shell.nix [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00
tailwind.config.js [add] pwa, icons, banner, themes 2023-11-11 16:43:32 -05:00

README.md


VReader allows you to take videos from YouTube and convert them into articles!

Running Server

# Locally (See "Development" Section)
export OPENAI_API_KEY=`cat openai_key`

vreader server run

# Docker Quick Start
docker run \
    -p 5000:5000 \
    -e OPENAI_API_KEY=`cat openai_key` \
    -e DATA_PATH=/data
    -v ./data:/data \
    gitea.va.reichard.io/evan/vreader:latest

The server will now be accessible at http://localhost:5000

Configuration

Environment Variable Default Value Description
OPENAI_API_KEY NONE Required OpenAI API Key for ChatGPT
DATA_PATH NONE Where to store the data

Development

# Initiate
python3 -m venv venv
. ./venv/bin/activate

# Local Development
pip install -e .

# Creds & Other Environment Variables
export OPENAI_API_KEY=`cat openai_key`

# Docker
make docker_build_local