Installation & Contributing

Installation

Installation is as simple as you’d expect. With pipenv:

$ pipenv install pyaltium

Or with poetry:

$ poetry add pyaltium

Or for standard pip:

$ pip install pyaltium

Contributing

Just start with the following:

$ pipenv install --dev

If you run into dependency issues:

$ pipenv install --dev --skip-lock

Write tests and make them pass, and add documentation for any externally-visible changes. I’m still getting tox running as of the time of writing but once it’s working, just run tox to verify it all. There is also a pre commit hook that can be added with:

$ pre-commit install