CipherSmith 0.1.0

A powerful and flexible command-line password generator

🔐 CipherSmith

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)

pip install CipherSmith

From Source

git clone https://github.com/Amul-Thantharate/CipherSmith.git
cd CipherSmith
pip install -e .

Development Installation

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

🎮 Usage

Basic Password Generation

# 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

# Generate a memorable password
CipherSmith generate --memorable

# Check password strength
CipherSmith check "YourPassword123"

Password Management

# View password history
CipherSmith history

# Search passwords
CipherSmith search "github"

# View statistics
CipherSmith stats

📚 Documentation

For detailed documentation, visit our Documentation Page.

Common topics:

• Installation Guide
• Usage Examples
• API Reference
• Contributing Guidelines

🔧 Configuration

CipherSmith can be configured using:

• Command-line arguments
• Configuration file (~/.CipherSmith/config.yaml)
• Environment variables

Example configuration:

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 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 file for details.

👥 Author

Amul Thantharate ([e-mail])

🌟 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: [e-mail]
• GitHub Issues: Report a bug
• Twitter: @AmulThantharate

⭐ Acknowledgments

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