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.2.3.tar.gz (6.6 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.2.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yapit-0.2.3.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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.2.3.tar.gz
Algorithm Hash digest
SHA256 bc5808da2e0ef82681f1fe8a1b7bab17a4dd4bfe44c187be4a5f39763f1d78ea
MD5 521943c2fa9073d7a181d6a740c31cd3
BLAKE2b-256 85a248e918a4dc29ef7922422f03ebe57644b33f2adcca8c6314acd2838c744c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yapit-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 26033a59869ebe00463aa16c3865174319c7d097468bcbd21d3acb3d8f06c23b
MD5 b8910f05a30efb80c6f73e2efa7b60d3
BLAKE2b-256 92242fd82644d1a77f1dfaa919b3f0ecd527461664f02903e0c57c0201d8cc0f

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