Metadata-Version: 2.4
Name: fast-password
Version: 1.0.1
Summary: Generate secure password fast
License: The MIT License (MIT)
        
        Copyright (c) 2025 Ram Amoncar <ramamonkar444@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: click>=8.2.0
Description-Content-Type: text/markdown

# Fast-Password

Fast-Password is a CLI tool and Python library for generating secure, random passwords quickly.

## Installation

Using `pip`

```bash
pip install fast-password
```

Using `uv`

```bash
uv tool install fast-password
```

```bash
uvx --from fast-password fp [OPTIONS] 
```

## CLI Usage

Generate passwords using the `fp` command:

```bash
fp [OPTIONS]
```

### Options

- `-l, --length INT`: Password length (default: 8)
- `-u, --upper`: Include uppercase characters
- `-n, --nums`: Include digits
- `-s, --special`: Include special characters
- `-e, --exclude TEXT`: Exclude specific characters
- `-a, --auto`: Randomly select unspecified options

### Example

```bash
> fp -l 12 -u -n -s
bn6s`c|5*L;8
```

## Library Usage

Use Fast-Password as a library to generate passwords programmatically:

```python
from fast_password import generate

password = generate(length=12, upper=True, nums=True, special=True, exclude="abc")
print(password)
```

## Requirements

- Python >= 3.10
- click >= 8.2.0

## Development

Install dev dependencies:

```bash
uv sync
```

Run tests:

```bash
uv run pytest tests
```

## License

See [LICENSE](LICENSE) file.