add some docs

This commit is contained in:
2025-01-03 15:16:23 +01:00
parent 45c06d081c
commit f7b369de95
5 changed files with 52 additions and 0 deletions

12
.gitignore vendored Normal file
View File

@@ -0,0 +1,12 @@
# Python-generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info
uv.lock
# Virtual environments
.venv
.aider*

1
.python-version Normal file
View File

@@ -0,0 +1 @@
3.12

20
README.md Normal file
View File

@@ -0,0 +1,20 @@
# What?
This is a CLI for summarizing YouTubes
## Installation
```bash
> python3 -m build && uv pip install --system dist/*.whl
```
## Usage
```bash
> yts <youtube URL>
```
## Default Behavior
The transcripts and summaries will be saved by default to `~/.yts/summaries` and `~/.yts/transcripts`.

18
pyproject.toml Normal file
View File

@@ -0,0 +1,18 @@
[project]
name = "summarize-yt"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
"anthropic>=0.42.0",
"hatchling>=1.27.0",
"yt-dlp>=2024.12.23",
]
[project.scripts]
yts = "summarize_yt.cli:main"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

1
summarize_yt/__init__.py Normal file
View File

@@ -0,0 +1 @@
__version__ = "0.1.1"