For bug fixes or new features, please file an issue before submitting a pull request. If the change isn't trivial, it may be best to wait for feedback.
You can just clone the GitHub repository to a local folder and start working from there:
$ git clone https://github.com/althonos/scoring-matrices
Tests are written as usual Python unit tests with the unittest
module of
the standard library. Running them requires the extension to be built
locally:
$ python setup.py build_ext --debug --inplace
$ python -m unittest discover -vv
This project targets Python 3.5 or later.
Python objects should be typed; since it is not supported by Cython,
you must manually declare types in type stubs (.pyi
files). In Python
files, you can add type annotations to function signatures (supported in
Python 3.5) but not in variable assignments (supported only from Python
3.6 onward). However, Cython allows you to use
f-strings
even when compiling the code for Python 3.5.
When interfacing with C or C++, and in particular with pointers, use assertions everywhere you assume the pointer to be non-NULL. Also consider using assertions when accessing raw C arrays, if applicable.