Installation¶

Requirements¶

Python 3.11 or higher
pip (comes with Python)

Install from Source¶

Clone the repository and install in editable mode:

git clone <your-repo-url>
cd inkfeed
pip install -e .

This installs the inkfeed command globally in your environment.

Optional Dependencies¶

Development Tools¶

pip install -e ".[dev]"

This adds:

pytest for running tests

Sleepscreen Output¶

The Sleepscreen format (e-ink optimized output) requires Playwright for headless browser rendering:

pip install -e ".[sleepscreen]"
playwright install chromium

Docker¶

If you prefer not to install Python dependencies locally, you can run Inkfeed in a container. A Dockerfile and docker-compose.yml are included for convenience.

# Edit config.toml to taste, then:
docker compose up --build

Archives will appear in the ./output/ directory on your host. To customise the configuration, edit config.toml before running — it is bind-mounted read-only into the container.

Verify Installation¶

inkfeed --help

Or run as a module:

python -m inkfeed

Dependencies¶

Inkfeed relies on these core libraries:

Package	Purpose
`httpx`	HTTP client for fetching articles
`jinja2`	Template rendering for output formats
`rich`	Beautiful terminal output and progress bars
`readability-lxml`	Article content extraction
`markdownify`	HTML-to-Markdown conversion
`ebooklib`	EPUB generation
`Pillow`	Image processing
`feedparser`	RSS/Atom feed parsing