Skip to content

Commit

Permalink
Beatifying the readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Average Blank committed May 16, 2024
1 parent 5bc3b98 commit e30762c
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 13 deletions.
64 changes: 58 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,58 @@
# Requirements
- Python
- There are certain requirements. To install the required libraries, run:
```
python3 -m pip install -r requirements.txt
```
# Password Manager

## About the Project
The Password Manager is a secure and efficient solution for storing and managing your passwords using SQLite3. This project is designed to help users keep track of their passwords in a safe and encrypted manner, providing a user-friendly interface for easy password retrieval and management. Developed with Python and various powerful libraries, this system ensures high security and ease of use for managing sensitive information.

## Purpose
The purpose of the Password Manager project is to offer a practical tool for managing passwords securely, leveraging SQLite3 for robust database operations and the `cryptography` library for encryption. By using this system, users can experience secure password storage, quick retrieval, and the convenience of a user-friendly command-line interface built with `questionary` and `rich`. This project aims to provide a valuable utility for everyday password management while showcasing the application of encryption and database management techniques.

## Preview
-- To Be Added --

## Setting Up Locally

### Prerequisites
Make sure you have Python installed on your system.

- **[Python](https://www.python.org/downloads/)**: Download and install Python.

### Installation Steps

1. **Clone the repository**
```bash
git clone https://github.com/AverageBlank/PasswordManager.git
cd PasswordManager
```

2. **Create a virtual environment**
```bash
python -m venv venv
venv\Scripts\activate # On bash use `source venv/bin/activate`
```

3. **Install the required libraries**
```bash
pip install pyperclip pwinput cryptography rich questionary
```

4. **Run the application**
```bash
python main.py
```

## Languages Used
- **Python**: The main programming language used for the backend.
- **SQL**: Language used for interacting with the SQLite3 database.

## Libraries Used
- **String**: Implements common string operations.
- **OS**: Allows interaction with the operating system.
- **random**: Implements pseudo-random number generators for various distributions.
- **time**: Provides various time-related functions.
- **sqlite3**: A built-in Python library for interacting with SQLite databases.
- **pyperclip**: A cross-platform Python module for clipboard functions.
- **pwinput**: A Python library for secure password input.
- **re**: Provides regular expression matching operations.
- **cryptography (fernet)**: A cryptography library for secure communications. Fernet is used for encryption and decryption.
- **questionary**: A Python library for building interactive command-line applications.
- **rich**: A Python library for rich text and beautiful formatting in the terminal.
5 changes: 0 additions & 5 deletions Requirements.txt

This file was deleted.

2 changes: 0 additions & 2 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,6 @@ def CopyEntry(t):
except InvalidToken:
sleep(1)
print("Please enter the correct encryption key.")
sleep(0.5)
cont().ask()


Expand Down Expand Up @@ -503,4 +502,3 @@ def PrintOptions():

#####* Printing Options #####
PrintOptions()

0 comments on commit e30762c

Please sign in to comment.