notepipe 0.1.0__tar.gz

notepipe-0.1.0/.gitattributes

@@ -0,0 +1 @@
+*.patch text eol=lf

notepipe-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+/target
+out/
+.pi/
+models/
+*.wav
+!tests/fixtures/speech.wav
+*.mp4
+.DS_Store
+.venv/
+__pycache__/
+out-bv/
+out-bench/
+out-gpu/
+out-smoke/
+adapters/speech-swift/native/.build/
+/adapters/speech-swift/target/
+/adapters/speech-swift/wheel-data/
+/dist/

notepipe-0.1.0/AGENTS.md

@@ -0,0 +1,56 @@
+# AGENTS.md
+
+Guidance for coding agents and contributors working in this repository.
+
+## Project
+
+notepipe is an extensible engine and command-line tool that turns video and audio into Markdown notes. Other programs can
+build on it, and it is useful on its own.
+
+## The core boundary
+
+The core turns a **local media file** into a **note folder**, and talks to the outside world only through standard
+protocols: ffmpeg for decoding, OpenAI-compatible HTTP APIs for speech recognition and language models, and the adapter
+contracts in `docs/` for anything else.
+
+Before adding code to `src/`, check it against this list. If any answer is yes, the code belongs in an adapter, in
+configuration or in documentation — not in the core:
+
+- Does it depend on a particular website, service vendor, model, operating system or package manager?
+- Does it need a local model, a GPU runtime or a platform SDK?
+- Does it decide how a note should read (wording, structure, which content to drop) instead of leaving that to the user's
+  prompts and settings?
+- Does it favor one language, region or script?
+- Is it an option, mode or abstraction that no current caller needs?
+
+## Layout
+
+- `src/` — the engine library and CLI.
+- `adapters/` — official adapters (speech recognition and media sources), each a separate package and an extra of
+  `notepipe` in `pyproject.toml`.
+- `tests/` — integration tests and fixtures.
+- `docs/` — adapter contracts and the CLI protocol.
+
+## Conventions
+
+- Prefer the smallest complete change. Delete rather than keep; do not add options, abstractions or dependencies that the
+  change does not need.
+- CLI messages are English. Prompts sent to models are English defaults that users can replace.
+- Machine-readable output (`--json`, `note.json`) is a contract: keep field names stable.
+
+## Before committing
+
+Run the same checks as `.github/workflows/ci.yml`:
+
+```sh
+cargo fmt --check
+cargo clippy --all-targets -- -D warnings
+cargo test --lib
+cargo test --test cli_ux --test task_execution
+cargo test --features integration --test scene_synthetic   # needs ffmpeg; not run on Windows
+```
+
+Adapters under `adapters/` have their own tests; run them from the adapter's directory.
+
+Write commit subjects as `area: summary` in the imperative mood, one concern per commit. Record user-visible changes under
+`Unreleased` in `CHANGELOG.md`.

notepipe-0.1.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to notepipe are documented in this file. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Adapters under `adapters/` are versioned separately.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-22
+
+The first release as notepipe. It started from course2md 2.0.0-rc.16 by mizorewww; this entry lists the differences.
+
+### Added
+
+- Audio files and audio-only online items as input.
+- Speech adapters: notepipe starts a local engine that serves an OpenAI-compatible transcription API for the run.
+  Official adapters for llama.cpp, OpenVINO, speech-swift (Apple silicon), xAI and Meta.
+- AI adapters: `[ai].adapter` starts a program that serves the AI stages through an OpenAI-compatible chat API, so other
+  APIs or subscription access can be connected.
+- Download adapters for URLs, with an official yt-dlp adapter; the core itself reads local files.
+- A configuration file whose sections follow the pipeline (`[output]`, `[transcript]`, `[speech]`, `[screenshots]`,
+  `[ai]`, `[download]`), with matching option names; `notepipe config path`; API keys are optional.
+- Prompt-driven AI stages (`[[ai.stages]]`): built-in `proofread` and `summary`, plus custom stages that replace
+  paragraphs, add text below them or add Markdown at the top of the note; per-stage model, endpoint, key and extra request
+  fields.
+- `--config FILE|-`, `--subtitle FILE`, `--stages`, `--no-stages`, `NOTEPIPE_SPEECH_API_KEY`, `NOTEPIPE_AI_API_KEY`.
+- `[output].on_complete`, a command run after each note is written.
+- Packages for `uv tool install`, with the official adapters as extras (`notepipe[ytdlp]`), and a release workflow that
+  publishes to PyPI and crates.io.
+
+### Changed
+
+- Speech detection uses earshot, a small built-in neural detector, instead of a fixed loudness threshold.
+- Notes are written as `<out>/<title>/note.md`, `images/` and `note.json`; `note.md` starts with YAML front matter.
+  Running again on the same source replaces its note; intermediate results are cached per source.
+- Default prompts are English and replaceable; summaries are Markdown written by the model in the transcript's language.
+- The CLI and `--json` output are English; NDJSON events are limited to `stage`, `progress`, `tokens`, `log`, `done` and
+  `error`.
+- Subtitles are chosen by the configured language, then the media's original language, instead of preferring Chinese.
+- Korean and other space-separated scripts keep their word spacing when transcript fragments are joined.
+- Ctrl-C (and SIGTERM on Unix) stops the run and any adapters it started.
+
+### Removed
+
+- The desktop application.
+- Built-in local speech backends (now adapters) and model management commands.
+- Bilibili login and site-specific handling, cookie options and other website-specific code (now in download adapters).
+- ChatGPT-subscription and Ollama login; every language model is reached as an OpenAI-compatible endpoint.
+- Interface translations, `--lang` and `NOTEPIPE_LANG`.
+- HTML and ZIP exports, versioned note storage, `run-task` and the `summarize` subcommand.
+- `--translate` (translation is a custom AI stage), `--formats`, `--no-download`, `--resume`, `--keep-video`.

notepipe-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [@3ae3ae](https://github.com/3ae3ae) on GitHub. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

notepipe-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to notepipe
+
+Bug reports, adapters and code changes are welcome.
+
+## Reporting problems
+
+Open an issue with the command you ran, what you expected and what happened. Run with `-v` (or `-vv`) and include the
+relevant log lines. Remove API keys, cookies and private URLs first.
+
+## Development setup
+
+You need Rust (see `rust-version` in `Cargo.toml`) and `ffmpeg` on `PATH`. The Python adapters use
+[uv](https://docs.astral.sh/uv/).
+
+```sh
+git clone https://github.com/3ae3ae/notepipe
+cd notepipe
+cargo build
+cargo run -- --help
+```
+
+## Checks
+
+Run the same checks as CI before opening a pull request:
+
+```sh
+cargo fmt --check
+cargo clippy --all-targets -- -D warnings
+cargo test --lib
+cargo test --test cli_ux --test task_execution
+cargo test --features integration --test scene_synthetic   # needs ffmpeg; not run on Windows
+```
+
+Each adapter under `adapters/` is a separate package with its own tests:
+
+```sh
+uv run --directory adapters/llama python -m unittest       # Python adapters
+cargo test --manifest-path adapters/speech-swift/Cargo.toml # speech-swift adapter (macOS arm64 with Xcode)
+```
+
+## Project layout
+
+| Path | Contents |
+|---|---|
+| `src/` | The engine and the `notepipe` CLI |
+| `adapters/` | Official speech and download adapters, each a separate package |
+| `tests/` | Integration tests and fixtures |
+| `docs/` | [CLI contract](docs/cli.md) and [adapter contracts](docs/adapters.md) |
+
+## What belongs in the core
+
+The core turns a local media file into a note folder and reaches everything else through standard interfaces: ffmpeg,
+OpenAI-compatible HTTP APIs and the adapter contracts. Code that depends on a particular website, vendor, model,
+operating system or package manager, that needs local models or platform SDKs, or that decides how a note should read
+belongs in an adapter, in configuration or in documentation instead. [AGENTS.md](AGENTS.md) has the full checklist.
+
+Prefer the smallest complete change: delete rather than keep, and do not add options, abstractions or dependencies the
+change does not need. CLI messages are English; prompts are English defaults that users can replace.
+
+## Writing an adapter
+
+See [docs/adapters.md](docs/adapters.md). Third-party adapters do not need to live in this repository; name the executable
+`notepipe-asr-<name>`, `notepipe-ai-<name>` or `notepipe-source-<name>` and publish it as a package.
+
+## Commits and pull requests
+
+- One concern per commit, with a subject like `area: summary` in the imperative mood (for example
+  `asr: retry on HTTP 429`), and the reason in the body.
+- Add a test for new behavior.
+- Record user-visible changes under `Unreleased` in [CHANGELOG.md](CHANGELOG.md).
+
+## Releases
+
+Pushing a tag `vX.Y.Z` runs `.github/workflows/release.yml`: it builds the CLI binaries and wheels and every adapter,
+attaches them with checksums to a GitHub release and publishes the packages to PyPI through trusted publishing. Versions
+of adapters that are already on PyPI are skipped, so bump an adapter's version when it changes. Each PyPI project
+publishes from its own GitHub environment, `pypi` for notepipe and `pypi-<package>` for an adapter, and its trusted
+publisher on PyPI names that environment.
+
+The same workflow publishes the crate to crates.io from the `crates-io` environment through trusted publishing, unless
+that version is already there.
+
+By contributing, you agree that your contributions are licensed under the [MIT License](LICENSE).