Installation¶

Install from PyPI¶

The latest released version of differences can be installed from PyPI using pip. Requires Python >= 3.10.

$ pip install differences

Optional dependencies¶

The [all] extra pulls in linearmodels, which is needed by differences.generate_data():

$ pip install "differences[all]"

Install from GitHub¶

To install the latest development version directly from a branch:

$ pip install "git+https://github.com/bernardodionisi/differences.git@main"

Development install¶

For local development, clone the repo and install in editable mode with the test extras:

$ git clone https://github.com/bernardodionisi/differences.git
$ cd differences
$ pip install -e ".[all,test]"

To reproduce the CI checks locally, run nox (runs the test and docs sessions).

Import¶

Import the differences package in Python.

In [1]: import differences

In [2]: differences.__version__
Out[2]: '0.3.0'