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

Uploaded Python 3

File details

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

File metadata

  • Download URL: yapit-0.2.5.tar.gz
  • Upload date:
  • Size: 6.7 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.5.tar.gz
Algorithm Hash digest
SHA256 6541a464bacb12ff7af952966bb52e96202a776df4d6f2e9cc6df32f7e2e826d
MD5 c4c70b51a60dba3ea49e0108e05e1698
BLAKE2b-256 be5a65956723f6e864e2b6780c937e34401c3f0975feea317192549f23242edc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yapit-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 7.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ca17f2ecf580d6a86949099611e3e6a537fdad3935def2b1fe8795fa6dd21aec
MD5 8ee151a352114233b6494ea046a74363
BLAKE2b-256 897581d232c83ada2ff79d015c489759553ebf3f7be94f1a783687bf4b97d713

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