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.5.tar.gz (8.2 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.5-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yapit-0.3.5.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","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.5.tar.gz
Algorithm Hash digest
SHA256 4f41e71a97eecb743ffcd3e4045b56e15d0a790f5635a39f74e5e40f963e7b4a
MD5 e34619260792828052f44e6fa1238321
BLAKE2b-256 089d03e38dbca467cdea07aa4b29dc05c6754e0cb4c19b84d54cf2f966b4d3de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yapit-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8dbf1008a9a1b759c978d3fbcea19b22ce4108c05cd8edeec9035f34e72a9db6
MD5 e5376cb2035e657dcf51330f2e09de9a
BLAKE2b-256 5c3df13118bc1c7982d8d405741f7faabc0b008854cd9d8cb0b6c34165426e14

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