Installation

These instructions assume you have Python installed on your system (>=3.11 recommended).

Since this project is fairly niche, it will likely never be published to PyPI, so it will need to be installed from source.

Note

It is highly recommended to install the project in a virtual environment. This can be done with the venv module that comes with Python.

Installing from source

To install the project from source, you can clone the repository and install it with pip:

git clone https://github.com/MansfieldTX-MattR/granicus-archiver.git
cd granicus-archiver
# Create a virtual environment and activate it
python -m venv .venv
source .venv/bin/activate
# Install the project in editable mode
pip install -e .

This will install the project and its dependencies in your Python environment. If successful, you should be able to run the CLI with the following command:

$ granicus-archiver --help
Usage: granicus-archiver [OPTIONS] COMMAND [ARGS]...
...