Installation

Installing from PyPI

The recommended way to install autopypath is via pip, the Python package installer. You can install it by running the following command in your terminal:

pip install autopypath

Installing from Source

If you prefer to install autopypath from the source code, you can clone the repository and install it manually. Here are the steps to do so:

git clone https://github.com/JerilynFranz/python-autopypath.git
cd python-autopypath
pip install .

Development Installation

For development purposes, you can install autopypath in editable mode.

This allows you to make changes to the source code and have them reflected immediately without needing to reinstall the package.

To make this easier, a bootstrap script is provided.

You can run the following commands:

Setting up the development environment

git clone https://github.com/JerilynFranz/python-autopypath.git
cd python-autopypath
python bootstrap.py

And then activate the virtual environment with:

Activating the virtual environment on Linux/macOS

source .venv/bin/activate

or on Windows use:

Activating the virtual environment on Windows

.venv\Scripts\activate

or if using PowerShell:

Activating the virtual environment on Windows PowerShell

.\.venv\Scripts\Activate.ps1

This will set up the development environment and install autopypath in editable mode.

It will also setup uv, tox, sphinx and other development dependencies to help with testing and building the project.

For information on contributing to autopypath, please refer to the Contributing section.