Skip to main content

Open-source capture layer that turns anything from the web into markdown files you own.

Project description

Amperstand

Amperstand captures articles, YouTube videos, feeds, and newsletters into markdown files you own.

It is local-first. You can run it on any computer with Python and write output directly into a folder or Obsidian vault. The HTTP server is optional and not required for the core workflow.

Install

git clone <your-repo-url>
cd amperstand
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
playwright install chromium

Quick Start

Capture an article:

amperstand capture https://example.com/article

Print markdown to stdout instead of writing a file:

amperstand capture https://example.com/article --stdout

Capture into a specific folder:

amperstand capture https://example.com/article --output ~/notes/inbox

What It Supports

  • Articles and web pages
  • YouTube videos and transcripts
  • RSS and Atom feeds
  • Newsletter emails and .eml files

Common Commands

amperstand feed add https://example.com/feed.xml
amperstand feed sync --output ~/notes/inbox

amperstand email parse ./newsletter.eml --output ~/notes/inbox

amperstand config show
amperstand --version

Local State

Amperstand stores local state in ~/.amperstand, including:

  • state.json for feed subscriptions and capture history
  • config.json for settings
  • amperstand.log for logs

Notes

  • Some JavaScript-heavy pages need Playwright. If Chromium has not been installed yet, run playwright install chromium.
  • YouTube capture uses yt-dlp.
  • Vault and git sync are optional. If you just want local files on another computer, you do not need the server at all.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amperstand-0.1.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amperstand-0.1.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file amperstand-0.1.0.tar.gz.

File metadata

  • Download URL: amperstand-0.1.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for amperstand-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0307502200c94175d8877659b792ebc146a649a6ee52b7b8f2f52f9aa2a246ff
MD5 af633a831acc9fb8991017152aa5b397
BLAKE2b-256 db679830ec3cc1a8e5276edd37bca9cda2e07adb1dcf526514fd4b2b75a19578

See more details on using hashes here.

File details

Details for the file amperstand-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: amperstand-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for amperstand-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84c0f65afb18c3e2519257f17c7964301ba03daa1edc06a8fe1625893007c204
MD5 49831a96c5d15a0c028784b3c6899a75
BLAKE2b-256 ce5ce0efe9683b360fd958056743b1b4a46e685cae70d2608b6fc42d1f7ee7f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page