Skip to content

Installation

Prerequisites

pydiggs requires Python 3.8 or later and depends on the following packages: * lxml - for XML processing and validation * rich - for colored console output

Stable Release

To install pydiggs, run this command in your terminal:

pip install pydiggs

This is the preferred method to install pydiggs, as it will always install the most recent stable release with all required dependencies.

If you don't have pip installed, this Python installation guide can guide you through the process.

Development Version

The latest development version can be installed directly from GitHub:

pip install git+https://github.com/xinp-hub/pydiggs.git

From Sources

The sources for pydiggs can be downloaded from the GitHub repo.

You can either clone the public repository:

git clone git://github.com/xinp-hub/pydiggs

Or download the tarball:

curl -OJL https://github.com/xinp-hub/pydiggs/tarball/master

Once you have a copy of the source, you can install it with:

# If you have Poetry installed (recommended for development)
poetry install

# Or using pip
pip install .

Verification

After installation, you can verify that pydiggs is installed correctly by running:

python -c "import pydiggs; print(pydiggs.__version__)"

This should print the version number of your installed pydiggs package.