Installation

Requirements

  • Python 3.10 or higher

  • pip package manager

Basic Installation

Install smpub from PyPI:

pip install smartpublisher

This installs the core package with CLI and basic functionality.

Optional Dependencies

HTTP/API Support

For FastAPI integration and Swagger UI:

pip install smartpublisher[http]

This includes:

  • FastAPI

  • uvicorn with standard extensions

Interactive Mode

For interactive parameter prompting with questionary:

pip install questionary

Questionary is a pure Python package that works on all platforms (Windows, macOS, Linux).

Development Tools

For contributing to smpub:

pip install smartpublisher[dev]

This includes pytest, coverage, black, ruff, and mypy.

Documentation

For building documentation:

pip install smartpublisher[docs]

This includes mkdocs, mkdocs-material, and mkdocstrings.

All Dependencies

Install everything:

pip install smartpublisher[all]

Verify Installation

Check that smpub is installed correctly:

smpub --version
python -c "import smartpublisher; print(smartpublisher.__version__)"

Next Steps