README.md

This is project is a desktop cryptography application written with Python. The encryption method is the Caesar cipher. 🌠

📌 Table of Contents

• Application screenshot
• Technologies
• Prerequisites
• How to run
• GUI modification
• License

Application screenshot

Technologies

• Python
• PySide2

Prerequisites

• Python 3.7.1+ installed in your machine

• Creation of virtual environment

   # Installing virtualenv for Python
   $ python3 -m pip install virtualenv
  
   # Creating your virtual environment
   $ python3 -m virtualenv name-of-your-virtual-environment
  
   # Activating virtual environment
   $ source name-of-your-virtual-environment/bin/activate

• Installing dependencies

   # Enter in folder of project
   $ cd cipher-of-caesar/

  Make sure what the virtual environment this activated.

   # Installing requirements
   (name-of-your-virtual-environment) $ pip install -r requirements.txt

How to run

With your virtual environment enabled

# Running the application
(name-of-your-virtual-environment) $ python main.py

GUI modification

If you choose modify GUI will need generate a Python class and file

• Generating a Python class from the .ui file

   # Enter in folder app of project
   $ cd app/

  Make sure what the virtual environment this activated.

   # Generating a Python class
   (name-of-your-virtual-environment) $ pyside2-uic ./UI/gui.ui > gui.py

  For more informations acess: Using .ui Files (QUiLoader and pyside2-uic)

• Generating a Python file from the .qrc file

   # Enter in folder app of project
   $ cd app/

  Make sure what the virtual environment this activated.

   # Generating a Python file
   (name-of-your-virtual-environment) $ pyside2-rcc ./UI/resources/resources.qrc -o resources_rc.py

  For more informations acess: Using .qrc Files (pyside2-rcc)

License

Released in 2020 📕 License.

Made with ❤️ by Igor Silva. This project is under the MIT license.

Give a ⭐ if this project helped you!