miracle091/Picocrypt
miracle091
/
Picocrypt
mirror of https://github.com/HACKERALERT/Picocrypt.git
1
0
Fork 0
Code Releases Activity

Added instructions to run from source

This commit is contained in:
Evan Su 2021-03-24 09:39:22 -04:00 committed by GitHub
parent b38b84283a
commit 2c1e14e0c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/README.md
View File

@ -1,11 +1,20 @@
# 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 <code>pip</code>: <code>argon2-cffi</code>, <code>pycryptodome</code>, and <code>reedsolo</code>.
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 make sure you have Python3 installed (any version >3.6 will do). Then, download <code>Picocrypt.py</code> from above. Now, install these dependencies via <code>pip</code>: <code>argon2-cffi</code>, <code>pycryptodome</code>, <code>reedsolo</code>, and <code>cython</code>.
# Work in progress, be patient
Next, download <code>tkinterdnd2.zip</code> from above. Extract it and go into it. Inside, you'll see two Python files and a directory called <code>tkdnd</code>.
# A note about reedsolo
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>
Now, find the directory where Python is installed. On Windows, for example, this folder would probably be here:
<code>C:\Users\(Your username)\AppData\Local\Programs\Python\PythonXX</code>.
Now, go into <code>Lib/<code> and then <code>site-packages</code>. Create a folder named <code>tkinterdnd2</code>. Go into there and copy <code>__init__.py</code> and <code>TkinterDnD.py</code> from the folder you extracted (<code>tkinterdnd2</code>) earlier to here.
Next, go back to the directory where Python is installed. Go into <code>tcl/</code> and then <code>tclX.X</code>. Go into the same folder you extracted earlier (<code>tkinterdnd2</code>) and go into <code>tkdnd/</code>, and then go into your respective platform folder. Copy all the files there into the <code>tclX.X</code> directory you just went into.
Finally, download <code>reedsolo.zip</code> from above, extract it, and go into the folder. Open up a terminal and <code>python setup.py install</code>. Then, <code>python setup.py install --native-compile</code>. Now you should now have a Python extension called <code>reedsolo.pyd</code> on Windows, <code>reedsolo.so</code> or <code>reedsolo.dylib</code> on MacOS, and <code>reedsolo.so</code> on Linux. Copy this file to the same directory where <code>Picocrypt.py</code> is.
Now you're all good. Just <code>python3 Picocrypt.py</code> and enjoy!
# External links
<ul>
<li>Argon2-cffi: https://github.com/hynek/argon2-cffi</li>
<li>Pycryptodome: https://github.com/Legrandin/pycryptodome</li>