MPC-KRY-Project

School project for BUTs MPC-KRY subject.

How to run

• Python3.8 is the recommended version, but the app can probably run even on lower python versions
• Before installing dependencies it is recommended to create a virtual environment, refer to the guides below
• Install tkinter dependency based on which OS you are on:
  • Debian/Ubuntu apt-get install python3-tk
  • Fedora/RHEL: dnf install python3-tkinter
• Install dependencies by running pip3 install -r requirements.py in the project root directory
• Run by launching the app.py file in the projects root directory with ./app.py
• The best way to run this on Windows is to install a Linux virtual machine
• test_pdf.pdf and test_text.txt can be used as test files

How to create a virtual environment

• Create a virtual environment with python3 -m venv path/to/myenv
• Start using venv with source path/to/myenv/bin/activate

Installing sqlcipher

• Optionally the script install_sqlcipher.sh can be used to install the sqlcipher binary, which can be used to check the contents of the encrypted database files

Documentation

• You can browse the documentation either in code or by visiting this website
• The hosted documentation is created using shpinx
  • Configuration files for creating the documentation are in the sphinx folder
  • In order to build the website from code documentation install sphinx with pip3 install sphinx
  • Move to the sphinx folder and run make html, output folder is _build/html