Skip to content

Latest commit

 

History

History
140 lines (94 loc) · 2.92 KB

README.md

File metadata and controls

140 lines (94 loc) · 2.92 KB
Raw

Password Manager for MergeFest Event

A CLI-based password manager built in Python for secure password storage and management.

Project Structure

/
├── main.py      # Entry point for executing the program
├── manager.py   # Core logic and functionality

Built With

  • Python: A versatile programming language.

Resources to Learn Python

Contributing

Before contributing, review the following:

  1. Rules for MergeFest: MergeFest Rules
  2. Contribution Guidelines: How to Contribute

Contribution Guidelines

  • Code Style: Follow best practices for Python coding.
  • Readable Commits: Write clear and descriptive commit messages.
  • Testing: Ensure your changes don’t break existing functionality.
  • Proof of Work: Attach a video showcasing the feature you implemented.

Looking for Guidance?

Join our Discord server: MergeFest Discord
Visit the python channel and ping 2Y for assistance.

Setup Instructions

  1. Fork the Repository and clone it to your local machine:

    git clone <repository_url>
cd <repository_directory>

  2. Set up SSH for GitHub to commit changes.

  3. Ensure Python 3 is installed:

    python3 --version

  4. Install required dependencies:

    pip install cryptography

  5. Run the Application:

    python3 main.py

Features

  • Encrypt and Store Passwords: Securely save your credentials.
  • Key Management: Generate and load encryption keys.
  • File-Based Storage: Organize passwords in a file.

Requirements

  • Python: Version 3.x or higher.
  • Library: cryptography

How to Use

  1. Start the Program:

    python3 main.py

  2. Menu Options:

    • 1: Create a new encryption key.
    • 2: Load an existing encryption key.
    • 3: Create a new password file.
    • 4: Load an existing password file.
    • 5: Add a new password to the file.
    • 6: Retrieve a password from the file.
    • q: Quit the application.

Example Usage

Create a New Key

Enter choice: 1
Enter key file path: keyfile.key

Add a New Password

Enter choice: 5
Enter site: github
Enter password: securepassword123

Retrieve a Password

Enter choice: 6
Enter site: github
Password for github is securepassword123

Security Note

  • Keep Your Encryption Key Safe:
    The encryption key is crucial for accessing your passwords. Losing it means your passwords cannot be decrypted.