Picocrypt/src/README.md

14 lines
1.6 KiB
Markdown
Raw Normal View History

2021-03-24 15:38:53 +13:00
# Instructions For Running Manually
2021-03-25 02:08:09 +13:00
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 <code>pip</code>: <code>argon2-cffi</code>, <code>pycryptodome</code>, and <code>reedsolo</code>.
2021-03-24 15:38:53 +13:00
# Work in progress, be patient
2021-03-16 08:15:39 +13:00
2021-03-16 12:23:48 +13:00
# A note about reedsolo
2021-03-17 07:54:41 +13:00
Picocrypt can use the raw <code>reedsolo</code> 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 <code>reedsolo</code>, and name it <code>creedsolo</code> (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>. See <a href="https://github.com/tomerfiliba/reedsolomon#installation" target="_blank">here</a> for instructions on building the extension. The Windows executable already bundles <code>creedsolo.pyd</code>, but for Linux or MacOS, 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 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.</strong>
2021-03-16 12:19:16 +13:00
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>