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:
- Run any command (e.g.
jinafetch fetch https://example.com) - You'll be prompted to enter your Jina API key
- 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
- Linux:
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jinafetch-0.2.1.tar.gz.
File metadata
- Download URL: jinafetch-0.2.1.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25382726310b58e3c28fcc8cd2511d6d9cb476cfdac2e3fc2dc77a39f9b44c3a
|
|
| MD5 |
c3c3fc71b7a82b8089eab4902c71f509
|
|
| BLAKE2b-256 |
6b371b33496169ba9589dbe529d6b12379d9613c310f7139ce9bbdb07fa9e0f1
|
File details
Details for the file jinafetch-0.2.1-py3-none-any.whl.
File metadata
- Download URL: jinafetch-0.2.1-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bfd5cb516259555f0012830b617e32344eca2ec6b6463eb803fd340bf1afe63
|
|
| MD5 |
b7f302d903b0f17d0c311a8e07e8ac3a
|
|
| BLAKE2b-256 |
a0978752a7500f433f6015a0673dcd2e29a24223d06743ecc0b7d0a4f208503a
|