Infrastructure
This MR adds a bunch of infrastructure things.
-
setup.py
and related makes this installable using eitherpip install .
orpython setup.py install
. It isn't uploaded to pypi, I figure it isn't mature enough for that and @andrew.matas should set up the authentication for that. - CI, the current CI does some basic tests (does the code install, can it be imported, does the syntax make sense)
- I added
pytest
testing for one function to demonstrate the basic syntax. - Documentation which should auto-generate the API and also display the tutorial notebooks.
I did add basically the full set of code quality checks that I regularly use, this will require users to stick to a machine determined code style. I like this and think it makes things more maintainable, but it can be removed if it gets annoying. You can see the kind of changes it requires as I autoformatted the code.