Installation¶

Install from PyPI¶

The latest released version of galois can be installed from PyPI using pip.

$ python3 -m pip install galois

Install from GitHub¶

The latest code on master can be installed using pip in this way.

$ python3 -m pip install git+https://github.com/mhostetter/galois.git

Or from a specific branch.

$ python3 -m pip install git+https://github.com/mhostetter/galois.git@branch

Editable install from local folder¶

To actively develop the library, it is beneficial to pip install the library in an editable fashion from a local folder. This allows any changes in the current directory to be immediately seen upon the next import galois.

Clone the repo wherever you’d like.

$ git clone https://github.com/mhostetter/galois.git

Install the local folder using the -e or --editable flag.

$ python3 -m pip install -e galois/

Install the dev dependencies¶

The development dependencies include packages for linting and unit testing. These dependencies are stored in pyproject.toml.

[project.optional-dependencies]
dev = [
    "pylint>=2.14",
    "pytest",
    "pytest-cov[toml]",
    "pytest-xdist",
    # "pytest-benchmark",  # Remove until py dependency is fixed (https://github.com/ionelmc/pytest-benchmark/issues/226)
]

Install the development dependencies by passing the [dev] extras to pip install.

$ python3 -m pip install galois[dev]