Picocrypt/src/README.md

14 lines
1.4 KiB
Markdown
Raw Normal View History

2021-03-16 12:19:16 +13:00
# Instructions
2021-03-16 12:12:28 +13:00
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 should work without any issues. If Picocrypt can't automatically install dependencies, install these dependencies via pip manually: <code>argon2-cffi</code>, <code>pycryptodome</code>, and <code>reedsolo</code>.
2021-03-16 08:15:39 +13:00
2021-03-16 12:15:38 +13:00
# Note about reedsolo
2021-03-16 12:23:22 +13:00
Picocrypt can use the raw <code>reedsolo</code> pip package by itself, but it is very slow because it's pure Python. It is recommended to compile a Python extension (.pyd/.so) for <code>reedsolo</code>, and name it creedsolo (ie. <code>creedsolo.pyd</code> or <code>creedsolo.so</code>). Make sure to include the extension in the same directory as <code>Picocrypt.py</code>. The Windows executable already bundles <code>creedsolo.pyd</code>, but for Linux, you'll have to build the Python extension yourself if you want better speeds. <strong>Building the extension is not necessary if you don't intend on using the Reed-Solomon feature extensively, or if you are okay with speeds ~1MB/s.</strong>
2021-03-16 12:19:16 +13:00
# External links
Here are the Github links of the dependencies of Picocrypt:
2021-03-16 12:23:22 +13:00
<ul>
<li>Argon2-cffi: https://github.com/hynek/argon2-cffi</li>
<li>Pycryptodome: https://github.com/Legrandin/pycryptodome</li>
<li>ReedSolo: https://github.com/tomerfiliba/reedsolomon</li>
</ul>