numcodecs
numcodecs copied to clipboard
Update developer installation guide
- use
--recursiveto clone the submodules too (I get a build error locally ifc-bloscis not cloned) - use the generic
HTTPSURLs instead of theSSHones (not everyone hasSSHkeys) - specify a command to install
numcodecsglobally (I noticed that runningpython setup.py build_ext --inplacedid not installnumcodecsin mypythonenvironment, but as it correctly built the package, the tests passed)
TODO:
- [ ] Unit tests and/or doctests in docstrings
- [ ]
tox -e py310passes locally - [ ] Docstrings and API docs for any new/modified user-facing classes and functions
- [ ] Changes documented in docs/release.rst
- [ ]
tox -e docspasses locally - [ ] GitHub Actions CI passes
- [ ] Test coverage to 100% (Coveralls passes)