Picocrypt/src
2021-03-24 09:08:09 -04:00
..
unstable Update README.md 2021-03-23 22:34:14 -04:00
Picocrypt.py v1.11 2021-03-23 20:02:00 -04:00
README.md Update README.md 2021-03-24 09:08:09 -04:00

Instructions For Running Manually

If you want to run from source or would like to use Picocrypt on any platform that supports Python, you're in the right place. To run Picocrypt from source, first install Python3 (any version >3.6 will do). Next, install these dependencies via pip: argon2-cffi, pycryptodome, and reedsolo.

Work in progress, be patient

A note about reedsolo

Picocrypt can use the raw reedsolo Python module by itself, but it is very slow because it's written in pure Python. It is recommended to compile a Python extension (.pyd/.so) for reedsolo, and name it creedsolo (ie. creedsolo.pyd or creedsolo.so). Make sure to include the extension in the same directory as Picocrypt.py. See here for instructions on building the extension. The Windows executable already bundles creedsolo.pyd, but for Linux or MacOS, you'll have to build the Python extension yourself if you want better speeds. Building the extension is not necessary if you don't intend on using the Reed-Solomon feature a lot, or if you are okay with slow Reed-Solomon speeds. Picocrypt will work just fine without the extension and just the way it is.