pypasscrypt 2.0.1

a module for testing new python features

PassCrypt

PassCrypt is a comprehensive command-line tool designed to securely store, manage, and access your passwords. Built with Python, PassCrypt leverages advanced encryption techniques to ensure your data remains safe and private.

Table of Contents

• Features
• Installation
  • Prerequisites
  • With pip
  • With Poetry
  • From Source
• Usage
  • Main Menu Options
• Download CLI Tool
• Development
• Contributing
• License

Features

• 🔒 Secure Storage: Utilizes Fernet symmetric encryption to securely store passwords.
• 🛠 Password Generation: Generates strong, context-aware passwords to enhance security.
• 🔄 Import/Export Functionality: Easily import or export your PassCrypt storage for backup or transfer.
• 🔑 Master Password Protection: Secures your password vault with a master password, ensuring only authorized access.
• 💻 Cross-Platform Compatibility: Designed to run on multiple platforms, ensuring your passwords are accessible wherever you are.

Installation

Prerequisites

Before installing PassCrypt, ensure you have the following:

• Python 3.7 or higher
• pip (Python package installer)
• Poetry (dependency management tool)

If you don't have Poetry installed, you can install it by following the instructions on the official Poetry website.

With pip

To install PassCrypt using pip, run the following command in your terminal:

pip install pypasscrypt

With Poetry

To install PassCrypt using Poetry, run the following command in your terminal:

poetry add pypasscrypt

From Source

To install PassCrypt from source, follow these steps:

• Clone the PassCrypt repository:

  git clone https://github.com/tejus3131/passcrypt
  

• Navigate to the project directory:

  cd passcrypt
  

• Install the package using Poetry:

  poetry install
  

Usage

After installing PassCrypt, you can start the application by running:

passcrypt

On first run, you'll be prompted to set up a master password. This password will be used to encrypt and decrypt your stored passwords, so make sure it's strong and memorable.

Main Menu Options

1. List All Passwords: Displays a table of all your stored passwords.
2. Add Password: Add a new password with options to generate a strong password.
3. Edit Password: Edit an existing password entry.
4. Remove Password: Remove a password entry.
5. Settings: Access various settings such as resetting the master password, importing/exporting storage, and more.

Download CLI Tool

For convenience, you can also download the PassCrypt CLI tool directly from the following link: PassCrypt CLI Tool

Development

To contribute to the development of PassCrypt, follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bugs, enhancements, or features you'd like to add. Make sure to follow the code of conduct and contribution guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.