Skip to main content

A CLI tool for password generation

Project description

PyPass Tool

pypass-tool is a Python-based password management utility that allows users to generate random passwords and store them inside a file for easy recall. It will check for password strength and provide options to adjust the length of the password and exclude specific characters. Users can choose to generate passwords using the command line (CLI), a web browser, or a desktop app.

Contents

Features | Installation | Build from scratch | Usage | Package Usage | Development | Contributing

Features

  • Command-Line Interface (CLI): Default interface for generating and managing passwords from the terminal.
  • Desktop GUI: Simple graphical interface using Tkinter for generating passwords on your desktop.
  • Web Interface: Web-based interface built with Flask for managing passwords through a browser.

Installation

Option 1: Install from PyPI

To install pypass-tool directly from PyPI:

pip install pypass-tool

Option 2: Build from Source

You can also clone the repository and build the package yourself.

  1. Clone the repository and navigate to the project directory:
git clone https://github.com/h471x/password_generator.git
cd password_generator
  1. Build the package:
python setup.py sdist bdist_wheel
  1. Install the package:
pip install dist/pypass_tool-*.whl

Usage

Once the package is installed, you can use the pypass command with different interfaces:

  • CLI Mode (default):

    pypass
    
  • Desktop GUI Mode:

    pypass gui
    
  • Web Interface Mode:

    pypass web
    

    Open your browser and navigate to http://127.0.0.1:5000.

Using as a Package

You can also use pypass-tool as a package in your own scripts. Here's an example:

from pypass import PasswordGenerator

def main():
    # Create an instance of PasswordGenerator
    new_pass = PasswordGenerator()
    
    # Set the desired password length and characters to exclude
    new_pass.set_password_length(16)
    new_pass.exclude_characters("weak12345")

    # Generate the password with the specified settings
    password = new_pass.generate_password()
    
    # Print the generated password
    print(f"Generated Password: {password}")

if __name__ == "__main__":
    main()

Development

To modify or extend the functionality, ensure you have the required dependencies installed. You can add new features to the CLI, desktop, or web interface as per the structure.

Dependencies

The required dependencies for the project are listed in setup.py:

  • Flask (for the web interface)
  • Tkinter (for the desktop GUI; included with Python)

Install the required dependencies using:

pip install -r requirements.txt

Contributing

Feel free to fork this repository, open issues, or submit pull requests with improvements or bug fixes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypass-tool-0.2.6.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

pypass_tool-0.2.6-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file pypass-tool-0.2.6.tar.gz.

File metadata

  • Download URL: pypass-tool-0.2.6.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for pypass-tool-0.2.6.tar.gz
Algorithm Hash digest
SHA256 c969a130aa07d5f4eb78e2969ac3dcfee020da4f5aa936665a20d866f105527f
MD5 5e087a7fde616a5c03c5ca260aa7ab81
BLAKE2b-256 39ad2143c42dd93cf0035b843fcd955382b2f5eaed52fe9b6fe8a621a57f6603

See more details on using hashes here.

File details

Details for the file pypass_tool-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: pypass_tool-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for pypass_tool-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d4fd5647633a3b19fff2edc9f7fa6c30044475d22bac4a07d11563482ee7c3e7
MD5 9332eff1dfc7e5de6765c2ed1292c117
BLAKE2b-256 5c20b28b30cca0213bf5971d91c701a8e5c20838f13889fe390296a20356a238

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page