1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
# cykhash for developers (i.e. future me)
## Dependencies:
Essential:
* Cython>=0.28 because verbatim C-code feature is used
* build tool chain (for example gcc on Linux)
Additional dependencies for testing:
* `sh`
* `virtualenv`
* `pytest`
* `numpy`, `pandas`, `perfplot` for performance tests
* `asv` for asv_bench testing (performance tests)
## Testing:
For testing of the local version in an virtual environment run:
sh test_install.sh
in the `tests` subfolder.
For testing of the version from github run:
sh test_install.sh from-github
For keeping the the virtual enviroment after the tests:
sh test_install.sh local keep
To install and running tests in currently active environment:
sh test_in_active_env.sh
For comparing performance of the HEAD with upstream/master:
sh run_asv_bench.sh
you might want to reduce the number of tests - see examples in `run_asv_bench.sh`
For running doc-tests:
sh run_doctests.sh
## Uploading to PyPi:
Follow procedure in `distribute/upload_to_pypi.sh`, i.e.
cd distribute
sh upload_to_pypi.sh
|