yttools 0.1.0__tar.gz

yttools-0.1.0/.gitignore

@@ -0,0 +1,256 @@
+# =============================================================================
+# Python
+# =============================================================================
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Distribution / packaging
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# =============================================================================
+# Virtual environments
+# =============================================================================
+.venv/
+venv/
+ENV/
+env/
+.python-version
+.tool-versions
+
+# =============================================================================
+# Testing and quality tools
+# =============================================================================
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+nosetests.xml
+.cache
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# Linters and formatters
+.ruff_cache/
+.pylint.d/
+
+# =============================================================================
+# Editors and IDEs
+# =============================================================================
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+*.sublime-project
+*.sublime-workspace
+.project
+.pydevproject
+.spyderproject
+.spyproject
+.ropeproject
+
+# Local editor and agent working directories
+.history/
+.local/
+.assistant/
+.agent/
+.agents/
+
+# =============================================================================
+# Operating systems
+# =============================================================================
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Linux
+*~
+.directory
+.fuse_hidden*
+.nfs*
+
+# Windows
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+*.stackdump
+[Dd]esktop.ini
+$RECYCLE.BIN/
+*.lnk
+
+# =============================================================================
+# Secrets and local config
+# =============================================================================
+.env
+.env.*
+!.env.example
+*.local
+*.local.toml
+*.local.yml
+*.local.yaml
+*.local.json
+secrets/
+.secrets/
+credentials.json
+client_secrets.json
+token.json
+service-account*.json
+
+# =============================================================================
+# YTtools runtime state
+# =============================================================================
+# Local data directories (when YTTOOLS_HOME is set to a project path)
+.yttools/
+data/
+runtime/
+
+# SQLite database files (database lives at ~/.yttools/ by default;
+# this catches any project-local development databases)
+yttools.db
+yttools.db-wal
+yttools.db-shm
+yttools.db-journal
+*.sqlite
+*.sqlite3
+*.db-wal
+*.db-shm
+
+# Transcript artifacts and exports
+transcripts/
+exports/
+*.vtt
+*.srt
+
+# Test fixtures are committed even though they share the extensions above.
+!tests/fixtures/*.vtt
+!tests/fixtures/*.srt
+
+# Ollama model cache (when configured to a project-local path)
+.ollama/
+
+# Job and progress state
+jobs/
+.progress/
+
+# =============================================================================
+# Private project files
+# =============================================================================
+# Operator playbook (commercial pricing, LLC notes, internal strategy)
+OPERATOR_NOTES.md
+OPERATOR_NOTES.*
+
+# Any file marked private by naming convention
+*_PRIVATE.md
+*.private
+*.private.*
+PRIVATE/
+private/
+
+# Signed CLA records (if mirrored locally instead of via CLA Assistant)
+signed_clas/
+contributor_records/
+
+# Commercial license agreements (executed contracts, customer data)
+commercial_licenses/
+customer_contracts/
+
+# =============================================================================
+# Build and deployment artifacts
+# =============================================================================
+node_modules/
+.npm
+.yarn-integrity
+package-lock.json
+yarn.lock
+
+# Generated documentation
+site/
+_site/
+docs/_build/
+docs/.doctrees/
+
+# Profiling
+*.prof
+*.lprof
+profile_*.txt
+
+# Logs
+*.log
+logs/
+*.log.*
+
+# =============================================================================
+# Miscellaneous
+# =============================================================================
+# Backup files
+*.bak
+*.backup
+*.old
+*.orig
+*.rej
+
+# Archive files (unless intentionally committed)
+*.zip
+*.tar
+*.tar.gz
+*.tgz
+*.rar
+*.7z
+
+# Temporary files
+tmp/
+temp/
+.tmp/
+*.tmp
+
+# Generated files
+*.generated.*
+generated/

yttools-0.1.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims to
+follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-05-24
+
+First public release: the storage layer, the Fetch tool, and the Search tool.
+
+### Added
+
+- Project scaffolding: AGPL-3.0 license, code of conduct, contribution guide,
+  Contributor License Agreements, issue and Pull Request templates.
+- `pyproject.toml` with hatchling builds, ruff, mypy (strict on `src/`), and
+  pytest configuration.
+- Core infrastructure:
+  - SQLite storage layer with a numbered migration runner, WAL journaling, and
+    foreign keys enforced. Full-text search via FTS5; an optional sqlite-vec
+    vector table is created when the extension is available.
+  - Pydantic v2 domain models for channels, playlists, videos, transcripts,
+    quotes, summaries, topics, and jobs.
+  - YouTube URL parsing for channel, playlist, and video forms plus bare
+    identifiers.
+  - Async yt-dlp wrappers for listing, metadata, and caption downloads, with
+    typed errors for unavailable, members-only, and live videos.
+  - WebVTT parsing that strips tags and speaker labels and collapses rolling
+    caption duplication into timestamped segments.
+  - Transcript exporters for `.txt`, `.md` (with timestamp links), `.srt`, and
+    `.json`, plus a zip bundler.
+  - An in-process publish/subscribe progress bus for server-sent events.
+  - An LLM provider abstraction with a fully wired local Ollama provider and
+    config-aware stubs for the three hosted providers (completion arrives in a
+    later release).
+- Fetch tool: a worker-pool job that downloads metadata and transcripts, skips
+  already-fetched videos unless forced or stale, and reports per-video progress.
+- Search tool: BM25-ranked full-text search with snippet highlighting,
+  timestamp deep-links, and channel, date, and duration filters.
+- Web UI: a FastAPI application serving Fetch, Search, and Settings pages with a
+  server-sent-events progress feed; built with Jinja2, Tailwind, and Alpine.
+- Command-line interface: `fetch`, `search`, `list`, `serve`, `config`, `db`,
+  and `version`.
+- Continuous integration across Linux, macOS, and Windows on Python 3.11 to
+  3.13, and a tag-triggered release workflow that publishes to PyPI via trusted
+  publishing.
+
+[Unreleased]: https://github.com/nicholsbill/YTtools/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/nicholsbill/YTtools/releases/tag/v0.1.0