Installation¶
Requirements¶
- Python 3.12 or higher
- pip or uv (Python package installer)
Install from PyPI¶
The simplest way to install the Substack API library is via pip:
pip install substack-api
Install from Source¶
Alternatively, you can install from source:
git clone https://github.com/nhagar/substack_api.git
cd substack_api
pip install -e .
Dependencies¶
The library has minimal dependencies:
- requests - For making HTTP requests
These dependencies will be automatically installed when you install the package.
CLI¶
Installing the package also installs the substack command-line tool:
substack --help
substack quickstart
See the CLI Guide for full documentation.