https://github.com/hatixntsoa/password.generator
A Simple Password Generator made with Python
https://github.com/hatixntsoa/password.generator
password-generator pypi-package python3
Last synced: 6 months ago
JSON representation
A Simple Password Generator made with Python
- Host: GitHub
- URL: https://github.com/hatixntsoa/password.generator
- Owner: hatixntsoa
- License: mit
- Created: 2024-09-21T07:42:24.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-09-01T06:00:19.000Z (11 months ago)
- Last Synced: 2025-09-01T19:14:31.620Z (11 months ago)
- Topics: password-generator, pypi-package, python3
- Language: Python
- Homepage: https://pypi.org/project/pypass-tool
- Size: 308 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](#features) |
[Installation](#installation) |
[Build from scratch](#option-2-build-from-source) |
[Usage](#usage) |
[Package Usage](#using-as-a-package) |
[Development](#development) |
[Contributing](#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:
```bash
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:
```bash
git clone https://github.com/hatixntsoa/password.generator.git
cd password.generator
```
2. Build the package:
```bash
python setup.py sdist bdist_wheel
```
3. Install the package:
```bash
pip install dist/pypass_tool-*.whl
```
## Usage
Once the package is installed, you can use the `pypass` command with different interfaces:
- **CLI Mode** (default):
```bash
pypass
```
- **Desktop GUI Mode**:
```bash
pypass gui
```
- **Web Interface Mode**:
```bash
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:
```python
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()
# Get the password strength
strength = new_pass.evaluate_strength(password)
# Print the generated password
print(f"Generated Password : {password}")
# print the password strength
print(f"Password Strength : {strength}")
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:
```bash
pip install -r requirements.txt
```
## Contributing
Feel free to fork this repository, open issues, or submit pull requests with improvements or bug fixes.