1.7 KiB
Instructions
Picocrypt is written to be cross-platform, so you should be able to run the raw Python file on your OS without any issues. Picocrypt's dependencies will be automatically installed via pip, which will usually work without any issues. If Picocrypt can't automatically install dependencies, install these dependencies via pip manually: argon2-cffi, pycryptodome, and reedsolo.
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.
External links
Here are the Github links of the dependencies of Picocrypt, if you are curious or want to audit them:
- Argon2-cffi: https://github.com/hynek/argon2-cffi
- Pycryptodome: https://github.com/Legrandin/pycryptodome
- ReedSolo: https://github.com/tomerfiliba/reedsolomon