Update README.md
provide instructions on how to run the script, current goals, and a short description
This commit is contained in:
48
README.md
48
README.md
@@ -1,2 +1,50 @@
|
||||
# ythdd
|
||||
*Archive videos while you watch them.*
|
||||
|
||||
**ythdd** is tool which can help you create a multimedia archive by downloading videos and their metadata while you watch them.
|
||||
It does so by acting as an intermediary between you and YouTube, forwarding your requests while also saving them to a hard drive, hence the name.
|
||||
|
||||
## Goals
|
||||
**Current goal of the project**: provide support for [Invidious](https://github.com/iv-org/invidious) API calls through the Invidious translation layer (ythdd_inv_tl.py).
|
||||
|
||||
## Running ythdd:
|
||||
- First, download project files or clone the repository with git:
|
||||
```
|
||||
git clone https://gitea.7o7.cx/sherl/ythdd.git
|
||||
```
|
||||
|
||||
- Navigate into the directory with project files:
|
||||
```
|
||||
cd ythdd
|
||||
```
|
||||
|
||||
- Create a virtual enviroment:
|
||||
```
|
||||
python -m venv .venv
|
||||
```
|
||||
Above will create a hidden directory called *.venv*.
|
||||
|
||||
- To activate the virtual enviroment use:
|
||||
- on Linux:
|
||||
```
|
||||
source .venv/bin/activate
|
||||
```
|
||||
- on Windows (cmd):
|
||||
```
|
||||
.venv\Scripts\activate
|
||||
```
|
||||
|
||||
- Install required packages into the newly created virtual environment:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
- Run the script:
|
||||
- continuously without interrupts:
|
||||
```
|
||||
python ythdd.py
|
||||
```
|
||||
- with automatic reloading (code will be reloaded after a change to the codebase)
|
||||
```
|
||||
flask --app ythdd run --debug
|
||||
```
|
||||
Reference in New Issue
Block a user