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)
  *.png         # extracted images

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.0.tar.gz (6.0 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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yapit-0.2.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","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.0.tar.gz
Algorithm Hash digest
SHA256 f7b6a62739465db6edc7801dc693afa5d7905acfcece7f06540bf353e0a918a8
MD5 e4f98f5347db890568ae5cd057648c5c
BLAKE2b-256 ff1fcf3087dd873a61d47ca26ba2a972163d8175886fac823bfa5e47f25deff2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yapit-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64151ad76f16916ec803191fffd3ccab64974703510ef190e433a8f8bc840534
MD5 be9b1cce332296b275f9556b49a06837
BLAKE2b-256 8681a16c657354b00641e6f3c3f7e62e49aaa10e0947b7ebe66cb3ddf0028ba1

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