diff --git a/Password_Manager/README.md b/Password_Manager/README.md index 96adb8b..dcb29bf 100644 --- a/Password_Manager/README.md +++ b/Password_Manager/README.md @@ -1,57 +1,127 @@ - # Password Manager +# ๐Ÿ” Password Manager -#### Description: +## ๐Ÿ“Œ Description -This is a simple command-line password manager app written in Python. It allows you to create, check, edit, and delete passwords associated with specific aims (e.g., program names, websites) and stores them in a CSV file. +This is a simple **command-line Password Manager application** built with **Python**. +It allows users to: -# Getting Started +* Create and store passwords for a specific purpose (website, app, or account) +* Check saved passwords +* Edit existing passwords +* Delete passwords +* Store password records in a CSV file -To use this password manager, follow these steps: +> โš ๏ธ This project is intended for **learning and basic utility purposes**. -1. Clone or download this repository to your local machine. -2. Make sure you have Python 3.x installed. -3. Install the required libraries by running the following command in your terminal or command prompt: - ```bash - pip install colorama -4. Run the password_manager.py script: - ```bash - python password_manager.py +--- -# Usage +## ๐Ÿš€ Getting Started -The Password Manager App provides the following options: +Follow these steps to run the project locally. -**Create Password:** Allows you to generate and save a new password for a specific aim (e.g., program or website). -**Check Password:** Allows you to check and display a password associated with a specific aim. -**Edit Password:** Allows you to change the password for a specific aim. -**Delete Password:** Allows you to delete a password entry for a specific aim. -**Exit:** Allows you to exit the Password Manager App. +### 1) Clone the repository -# Creating a Password -To create a password for a specific aim, choose option 1, and then enter the aim (e.g., program or website) for which you want to create a password. The app will generate a random password for you and display it. Make sure to save this password in a safe place since it will not be retrievable again. +```bash +git clone +cd Python_Project/Password_Manager +``` -#ย Checking a Password -To check a password associated with a specific aim, choose option 2, and then enter the aim. The app will display the password if it exists in the database. +### 2) Install requirements -# Editing a Password -To change the password associated with a specific aim, choose option 3, and then enter the aim. You will be prompted to enter a new password, and it will be updated in the database. +```bash +pip install colorama +``` -#ย Deleting a Password -To delete a password entry for a specific aim, choose option 4, and then enter the aim. The password associated with that aim will be deleted from the database. +### 3) Run the project -#ย Exiting the App -To exit the Password Manager App, choose option 5. +```bash +python project.py +``` -#ย CSV File +--- -The app stores password information in a CSV file named password.csv in the same directory as the script. You can manually edit this file if needed. +## ๐Ÿง‘โ€๐Ÿ’ป Features -# Security Notice +The Password Manager provides the following options: -This Password Manager App is a simple utility for managing passwords and does not provide advanced security features. As the CSV file containing passwords is not encrypted, it's essential to keep it secure. +* **Create Password** โ†’ Generate and save a password for a specific aim +* **Check Password** โ†’ View the password for a saved aim +* **Edit Password** โ†’ Update the password of an existing entry +* **Delete Password** โ†’ Remove a password entry +* **Exit** โ†’ Close the application +--- +## ๐Ÿ“– Usage Guide +### โž• Create a Password +Choose **Option 1** and enter the purpose (for example: website, email, or app). +The application generates a password and saves it in the CSV file. +### ๐Ÿ” Check a Password +Choose **Option 2** and enter the saved purpose. +The application displays the corresponding password if it exists. + +### โœ๏ธ Edit a Password + +Choose **Option 3** and enter the purpose. +Then provide a new password to update the existing record. + +### ๐Ÿ—‘๏ธ Delete a Password + +Choose **Option 4** and enter the purpose. +The password record will be removed. + +### โŒ Exit + +Choose **Option 5** to safely exit the application. + +--- + +## ๐Ÿ“‚ Data Storage + +All passwords are stored in: + +```text +password.csv +``` + +This file is located in the same directory as `project.py`. + +--- + +## โš ๏ธ Security Notice + +This password manager stores passwords in a **plain CSV file**, which means the data is **not encrypted**. + +Please note: + +* Do **not** use this project for real sensitive passwords +* Keep `password.csv` secure +* Use it mainly for **learning and practice purposes** + +--- + +## ๐Ÿ› ๏ธ Tech Stack + +* Python 3 +* CSV file handling +* Colorama + +--- + +## ๐Ÿค Contribution + +Contributions are welcome! +You can improve: + +* README documentation +* code readability +* encryption support +* password strength checks +* error handling +* CSV structure + +Happy coding ๐Ÿš€