Install

User Installation

Install the published command with uv:

uv tool install article-cli
article-cli --help

Upgrade an existing tool installation with:

uv tool upgrade article-cli

Development Checkout

git clone https://github.com/feelpp/article.cli.git
cd article.cli
uv sync --all-extras --dev
uv run article-cli --help

The supported Python versions are 3.9, 3.10, 3.11, 3.12, 3.13.

Development Checks

uv run pytest
uv run black --check src tests
uv run flake8 src/ --count --select=E9,F63,F7,F82 --show-source --statistics
uv run mypy src/
uv build

The GitHub Actions workflow runs the test suite across Python 3.9 through 3.13.

Documentation Site

The documentation is an Antora site using the Feel++ Antora UI bundle.

npm install
npm run docs:build
npm run docs:preview

The generated site is written to build/site.