Contributing
Contributions are welcome! Development happens at
GitHub. Feel free to submit
ideas, bug reports and pull requests.
If you found a bug in a C++ part please report it to the original
bug tracker.
Navigating the source code
There are 4 folders in repository:
bench – benchmarks & benchmark data;lib – original unmodified marisa-trie C++ library which is a git
submodule; if something is have to be fixed in this library
consider fixing it in the original repo;src – wrapper code; src/marisa_trie.pyx is a wrapper implementation;
src/*.pxd files are Cython headers for corresponding C++ headers;
src/*.cpp files are the pre-built extension code and shouldn’t be
modified directly (they should be updated via update_cpp.sh script).tests – the test suite.
Running tests and benchmarks
Make sure tox is installed and run
from the source checkout. Tests should pass under Python 2.7,
3.4 and 3.5.
In order to run benchmarks, type