Metadata-Version: 2.1
Name: CipherSmith
Version: 0.1.0
Summary: A powerful and flexible command-line password generator
Home-page: https://github.com/Amul-Thantharate/CipherSmith
Author: Amul Thantharate
Author-email: amulthantharate@gmail.com
Project-URL: Bug Tracker, https://github.com/Amul-Thantharate/CipherSmith/issues
Project-URL: Documentation, https://CipherSmith.readthedocs.io
Project-URL: Source Code, https://github.com/Amul-Thantharate/CipherSmith
Keywords: password generator cli security cryptography
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Security
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: colorama>=0.4.6
Requires-Dist: cryptography>=41.0.0
Requires-Dist: pyyaml>=6.0.1

# 🔐 CipherSmith

[![PyPI version](https://badge.fury.io/py/CipherSmith.svg)](https://badge.fury.io/py/CipherSmith)
[![Python Versions](https://img.shields.io/pypi/pyversions/CipherSmith.svg)](https://pypi.org/project/CipherSmith/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://pepy.tech/badge/CipherSmith)](https://pepy.tech/project/CipherSmith)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A powerful and flexible command-line password generator that helps you create strong, secure passwords with ease. Built with security and usability in mind! 🚀

## ✨ Features

- 🎯 Generate cryptographically secure passwords
- 🔄 Customizable length and complexity
- 🎨 Include or exclude special characters, numbers, and uppercase letters
- 📋 Copy generated passwords to clipboard
- 💾 Save passwords to an encrypted file (optional)
- 🖥️ Command-line interface for easy integration into scripts
- 🔍 Password strength analysis
- 🏷️ Tag and organize passwords
- 📊 Password generation statistics
- 🔒 Secure storage using SQLite with encryption

## 🚀 Quick Start

### Prerequisites

- Python 3.9 or higher
- pip (Python package installer)

### Installation

#### From PyPI (Recommended)
```bash
pip install CipherSmith
```

#### From Source
```bash
git clone https://github.com/Amul-Thantharate/CipherSmith.git
cd CipherSmith
pip install -e .
```

#### Development Installation
```bash
git clone https://github.com/Amul-Thantharate/CipherSmith.git
cd CipherSmith
pip install -r requirements.txt
pip install -e .[dev]
```

## 🎮 Usage

### Basic Password Generation
```bash
# Generate a default secure password
CipherSmith generate

# Generate a password with specific length
CipherSmith generate --length 16

# Generate a password with specific requirements
CipherSmith generate --uppercase 2 --lowercase 6 --digits 2 --special 2

# Generate multiple passwords
CipherSmith generate --count 5

# Save passwords to file
CipherSmith generate --save passwords.txt --count 3
```

### Advanced Features
```bash
# Generate a memorable password
CipherSmith generate --memorable

# Check password strength
CipherSmith check "YourPassword123"
```

### Password Management
```bash
# View password history
CipherSmith history

# Search passwords
CipherSmith search "github"

# View statistics
CipherSmith stats
```

## 📚 Documentation

For detailed documentation, visit our [Documentation Page](https://CipherSmith.readthedocs.io/).

Common topics:
- [Installation Guide](LOCAL_INSTALL.md)
- [Usage Examples](DEMO.md)
- [API Reference](https://CipherSmith.readthedocs.io/api)
- [Contributing Guidelines](CONTRIBUTING.md)

## 🔧 Configuration

CipherSmith can be configured using:
- Command-line arguments
- Configuration file (~/.CipherSmith/config.yaml)
- Environment variables

Example configuration:
```yaml
default_length: 16
include_special: true
save_directory: "~/passwords/"
encryption_key_file: "~/.CipherSmith/key"
```

## 🛡️ Security

- Uses Python's `secrets` module for cryptographically secure random generation
- Implements industry-standard password security practices
- Regular security audits and updates
- No cloud storage - all data stays local
- Optional file encryption using Fernet (symmetric encryption)

## 🤝 Contributing

We love your input! We want to make contributing to CipherSmith as easy and transparent as possible. Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

1. Fork the repo
2. Create your feature branch (`git checkout -b feature/amazing`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing`)
5. Open a Pull Request

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 👥 Author

Amul Thantharate (amulthantharate@gmail.com)

## 🌟 Support

If you find CipherSmith useful, please consider:
- Giving it a star on GitHub ⭐
- Sharing it with friends and colleagues
- Contributing to its development
- Reporting issues and suggesting features

## 📊 Project Status

- ✅ Actively maintained
- 🔄 Regular updates
- 📈 Growing community
- 🐛 Quick bug fixes

## 📞 Contact

- Email: amulthantharate@gmail.com
- GitHub Issues: [Report a bug](https://github.com/Amul-Thantharate/CipherSmith/issues)
- Twitter: [@AmulThantharate](https://twitter.com/AmulThantharate)

## ⭐ Acknowledgments

- Thanks to all contributors
- Inspired by best practices in password security
- Built with Python's excellent cryptography libraries
