From f7b369de95dd5e46364313ba8c6b0ad974fb5f62 Mon Sep 17 00:00:00 2001
From: Zev Averbach <zev@averba.ch>
Date: Fri, 3 Jan 2025 15:16:23 +0100
Subject: [PATCH] add some docs

---
 .gitignore               | 12 ++++++++++++
 .python-version          |  1 +
 README.md                | 20 ++++++++++++++++++++
 pyproject.toml           | 18 ++++++++++++++++++
 summarize_yt/__init__.py |  1 +
 5 files changed, 52 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 .python-version
 create mode 100644 README.md
 create mode 100644 pyproject.toml
 create mode 100644 summarize_yt/__init__.py

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e87e23b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+uv.lock
+
+# Virtual environments
+.venv
+.aider*
diff --git a/.python-version b/.python-version
new file mode 100644
index 0000000..e4fba21
--- /dev/null
+++ b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6619301
--- /dev/null
+++ b/README.md
@@ -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`.
+
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..6beac04
--- /dev/null
+++ b/pyproject.toml
@@ -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"
diff --git a/summarize_yt/__init__.py b/summarize_yt/__init__.py
new file mode 100644
index 0000000..485f44a
--- /dev/null
+++ b/summarize_yt/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.1.1"