The latest release of
formulaic is always published to the Python
Package Index (PyPI), from which it is available to download @
If your Python environment is provisioned with
from the PyPI is as simple as running:
$ pip install formulaic
If you have a non-standard setup, ensure that
pip above are replaced with
the executables corresponding to the environment for which you are
interested in installing
formulaic. This is done automatically if you are
using a virtual environment.
You are ready to use Formulaic. To get introduced to the concepts underpinning Formulaic, please review the Concepts documentation, or to jump straight to how to use Formulaic, please review the User Guides documentation.
Installing for development
If you are interested in developing
formulaic, you should clone the source
code repository, and install in editable mode from there (allowing your changes
to be instantly available to all new Python sessions).
To clone the source code, run:
$ git clone email@example.com:matthewwardrop/formulaic.git
This requires you to have a GitHub account set up. If you do not have an
account you can replace the SSH url above with
https://github.com/matthewwardrop/formulaic.git. Also, if you are planning
to submit your work upstream, you may wish to fork the repository into your
own namespace first, and clone from there.
To install in editable mode, run:
$ pip install -e <path_to_cloned_formulaic_repo>
pip>=21.3in order for this to work.
You can then make any changes you like to the repo, and have them be reflected in your local Python sessions. Happy hacking, and I look forward to your contributions!
Dependencies are managed using Poetry, and if you
need to add a dependency, please use
poetry add ..., which will ensure
consistency of testing environments/etc.