Skip to main content

CLI tool to fetch and save web content as Markdown files using Jina Reader API. Handles authentication and provides rich terminal output.

Project description

JinaFetch

A CLI tool to fetch web content and save it as Markdown using Jina Reader API.

Features

  • 🚀 Fast web content conversion to Markdown
  • 🔑 Secure API key management via .env
  • 🎨 Rich terminal output with success/error formatting
  • 📂 Automatic filename generation with fallback

Installation

pipx install jinafetch  # Recommended
# or
pip install jinafetch

Usage

Configure API Key

jinafetch configure  # Update stored API key
jinafetch show-config  # See where credentials are stored

Basic fetching

jinafetch fetch https://example.com

Specify output file

jinafetch fetch https://example.com --output my_document.md

Environment Configuration

The CLI will guide you through first-time setup:

  1. Run any command (e.g. jinafetch fetch https://example.com)
  2. You'll be prompted to enter your Jina API key
  3. Your key will be securely stored in:
    • Linux: ~/.config/jinafetch/config.ini
    • macOS: ~/Library/Application Support/jinafetch/config.ini
    • Windows: C:\Users\<user>\AppData\Local\jinafetch\config.ini

For CI/CD use cases, you can still set via environment variable:

export JINA_API_KEY=your_key_here
# or
JINA_API_KEY=your_key_here jinafetch fetch...

Error Handling

Common error scenarios include:

  • 🔒 Missing API key
  • 🌐 Network errors
  • 💾 File write permissions
  • 🔗 Invalid URLs

Errors display clear messages in red with details.

Requirements

  • Python 3.12+
  • Valid Jina Reader API key

📝 Note: Requires valid authentication via Jina Reader API

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

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

jinafetch-0.2.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

jinafetch-0.2.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jinafetch-0.2.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for jinafetch-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fda38e5d42a1af861f84cd7413bade4300395dff9ca43e86617385717a0accf8
MD5 5cc135c4b4fc33558429b554de7a94fb
BLAKE2b-256 d77fa0620e433d8411b79c40a19de2b882a910d98eb0a3e4c2f8487315a1d647

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jinafetch-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for jinafetch-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e880fd3ff27d072f2c4e283e2cff9052236c8217ee47789d0ef326bc36a50cf
MD5 cbb9be174feaa9966a96eba923fd5d34
BLAKE2b-256 d5755eb2ec2983f44b80fd3a0815b47f93fc5f3ec2d9c6ec6f5504f93fdfc076

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