https://github.com/deepesh611/eagle-encryptor
A Desktop application to Encrypt the contents of a file, and this application supports most of the file formats.
https://github.com/deepesh611/eagle-encryptor
encryption-decryption file-security powershell-script python
Last synced: 12 months ago
JSON representation
A Desktop application to Encrypt the contents of a file, and this application supports most of the file formats.
- Host: GitHub
- URL: https://github.com/deepesh611/eagle-encryptor
- Owner: deepesh611
- License: mit
- Created: 2024-01-01T06:40:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T13:37:32.000Z (over 1 year ago)
- Last Synced: 2024-11-01T14:30:43.490Z (over 1 year ago)
- Topics: encryption-decryption, file-security, powershell-script, python
- Language: Python
- Homepage:
- Size: 1.89 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🦅 *Eagle-Encryptor 3.0*
This simple Python tool allows users to encrypt and decrypt files of a certain format. It provides a user-friendly interface for securing files with encryption and managing a local list of up to 1000 encrypted files. Additionally, the list of files and their details are stored in a MySQL database for easy & secure retrieval. There is also a password required to open the application. By default the password is `admin` however, the application gives an option to change it.
## Table of Contents
- 🚀 [Features](#-features)
- 🛠️ [Getting Started](#-getting-started)
- 📝 [Usage](#-usage)
- 🤝 [Contribution](#-contribution)
- 📄 [License](#license)
- [Release Notes](https://github.com/deepesh611/Eagle-Encryptor/blob/main/Release%20Notes.md)
## 🚀 Features
1. **File Encryption:**
- The tool supports the encryption of various text file formats such as `.word`, `.py`, `.txt`, `.jpg`, and more.
- A list of all supported formats is given below.
2. **Password Management:**
- Users can set and change the application password if they wish to.
3. **Local File-Location Storage:**
- The tool can manage a local list of storing up to 1000 file paths so that the user does not have to give the file path every time the user opens the application.
4. **MySQL Integration:**
- The list of files is stored in a MySQL database for efficient & secure organization and easy retrieval.
## 🛠️ Getting Started
To use the Encryptor-Decryptor tool, follow these steps:
1. **Clone the Repository:**
- You can clone this repository by executing the following command on the terminal (cmd).
```bash
git clone https://github.com/deepesh611/Eagle-Encryptor.git
```
3. **Install Dependencies:**
- Before Installing the Application,t you should have the following installed.
`Python (3.11.x)`
`pip3`
`MySQL` (Along with the `Python-MySQL Connector` (Available in MySQL Installer - Community)) OR you can proceed with the `Wampserver64`
- To install the application, clone this repository to the preferred location, then enter the following commands in `Powershell`/`CMD`. **(RUN AS ADMINISTRATOR)**
```bash
cd '.\Eagle Encryptor'
.\setup.ps1
```
- If the terminal shows an error to run the script, try the following commands:
```bash
Set-ExecutionPolicy RemoteSigned
.\setup.ps1
```
## 📝 **Usage**
- Launch the tool using
```bash
cd src
python ./dist/main.py
```
- Here is a list of accepted file formats:
| ***Domain*** | ***Extensions*** |
| ------------------- | ---------------------------------- |
| Text | `.txt`,`.py`, `.pdf`,`.word`,`.xlsx`, `.html`, `.css`, `.c`, `.cpp`, `.php`, etc.|
| Images | `.png`, `.ico`, `.jpg`, `.jpeg`, `.img` |
- Type `help` to view the list of all the Commands:
| ***COMMANDS*** | ***TASK*** |
| ------------------ | -------------------------------------- |
| `ls` | Shows List of all Commands |
| `encf` / `ef` | Encrypt a File from Your List |
| `decf` / `df` | Decrypt a File from Your List |
| `view` / `v` | View List of Files |
| `add` / `a` | Add a File in your List |
| `del` / `d` | Delete a File from Your List |
| `delall` / `da` | Delete All Files from the List |
| `pwd` / `cp` | Change Password |
| `quit` / `q` | Exit the Application |
- Use the given commands to encrypt, decrypt, change the password, or use other functions
- Make sure that you do the following things after installation:
- `hide the subfolder where the main Python script is stored`
- `Create the Application Shortcut to Desktop`
## 🤝 **Contribution**
Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to create an issue or submit a pull request.
## 📄**License**
This project is licensed under the MIT License.