Skip to main content

CLI for yapit.md — fetch clean markdown from URLs and documents

Project description

yapit

CLI for yapit.md — fetch clean markdown from URLs, files, and documents.

Install

uv tool install yapit

Usage

# Create document from URL, print markdown
yapit https://example.com/article
yapit https://arxiv.org/abs/2301.00001

# Local files
yapit paper.pdf
yapit notes.md

# With AI transformation (TTS annotations, spoken readings for math, figure extraction, noise filtering)
yapit paper.pdf --ai

# Fetch existing document
yapit https://yapit.md/listen/<doc-id>
yapit <doc-id> --annotated

# Save to directory with images
yapit <doc-id> -o .

# Stdin
echo "hello world" | yapit -

Auth

Creating documents or accessing private docs requires a yapit.md account:

export YAPIT_EMAIL=you@example.com
export YAPIT_PASSWORD=...

Fetching shared documents works without auth.

Save to directory (-o)

-o <dir> saves markdown, TTS annotations, and images:

<dir>/<slug>/
  <slug>.md       # clean markdown, image paths rewritten to relative
  TTS.md          # annotated version (yap-speak, yap-show tags)
  <slug>-<N>.png  # images renamed sequentially

Errors if the output directory already exists.

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

yapit-0.3.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

yapit-0.3.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file yapit-0.3.0.tar.gz.

File metadata

  • Download URL: yapit-0.3.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for yapit-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d45b7a3e156dcda2c99fe343864dd497260d670889b690ec17034723870a0fe9
MD5 471efcb24e5a45d826a4ab10b46c6e4e
BLAKE2b-256 c6403e41ea26f5e93a75bd5ab3bab23538e1f94b37331690425b204bf78e4afe

See more details on using hashes here.

File details

Details for the file yapit-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: yapit-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for yapit-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39bca4e2d28044453066415b2cbc4d6a4ae382c64252937cdcbb7fb3aed30994
MD5 86a83adf0ca039154ef911ecaf1e02d5
BLAKE2b-256 b15d456e96e4ae5c2d9ecde38728c3ed9cf3db37c645426d9163fb89c20742fd

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