Metadata-Version: 2.1
Name: locksmithy
Version: 0.1.0
Summary: A simple password generator
Home-page: https://github.com/llyram/locksmithy
Author: Maryll Castelino
Author-email: maryllcastelino@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

Sure, here is a basic README file template for the Locksmith password generator project:

# Locksmith Password Generator

Locksmith is a simple password generator tool that generates strong, random passwords with various options for customization.

## Installation

To install Locksmith, you can use `pip`:

```
pip install locksmithy
```

Alternatively, you can clone the repository and install it manually:

```
git clone https://github.com/yourusername/locksmith.git
cd locksmith
pip install .
```

## Usage

To generate a password with the default options (10 characters, lowercase letters only), simply run:

```
locksmith
```

To specify the length of the password, use the `-l` or `--length` flag followed by the desired length:

```
locksmith -l 16
```

To include numbers in the password, use the `-n` or `--numbers` flag:

```
locksmith --numbers
```

To include special characters in the password, use the `-s` or `--special` flag:

```
locksmith --special
```

To include uppercase letters in the password, use the `-u` or `--uppercase` flag:

```
locksmith --uppercase
```

You can combine these options to create passwords with your desired characteristics:

```
locksmith -l 20 -nus
```

## License

Locksmith is licensed under the [MIT License](https://github.com/yourusername/locksmith/blob/master/LICENSE).

## Contributing

If you would like to contribute to Locksmith, please feel free to submit a pull request or open an issue on the [GitHub repository](https://github.com/yourusername/locksmith).
