Installation

pip

Stable Version

PyXX has been packaged through PyPI, so the easiest way to install the latest package release is through pip:

Linux / MacOS

pip install pyxx

Windows

pip install pyxx

As with any Python project, it may be useful to consider setting up a virtual environment and installing packages in it.

Development Version

To use the latest PyXX features prior to their release on PyPI, you can install the package directly from the project’s GitHub page using:

Linux / MacOS

pip install git+https://github.com/nathan-hess/python-utilities.git@main

Windows

pip install git+https://github.com/nathan-hess/python-utilities.git@main

Source Code

Alternatively, if you prefer to work from the source code directly, you can download the source code using Git, and then add the download directory to your PYTHONPATH environment variable so that the PyXX can be imported from scripts or Python terminals.

Note

Some functionality, such as command-line utilities, will not be available if setting up PyXX using this method.

First, clone the source repository to a location of your choice:

Linux / MacOS

git clone https://github.com/nathan-hess/python-utilities.git

Windows

git clone https://github.com/nathan-hess/python-utilities.git

Then, add the root directory of the repository to your PYTHONPATH environment variable:

Linux / MacOS

export PYTHONPATH="$PYTHONPATH:$(pwd)/python-utilities"

Windows

set PYTHONPATH=%PYTHONPATH%;%CD%\python-utilities

Finally, make sure to install required dependencies through pip:

Linux / MacOS

pip install -r python-utilities/requirements.txt

Windows

pip install -r python-utilities\requirements.txt