Metadata-Version: 2.4
Name: duckmail
Version: 0.1.0
Summary: Lightweight CLI for DuckDuckGo Email Protection
Author: DuckMail Contributors
License: MIT
Project-URL: Homepage, https://github.com/yourusername/duckmail
Project-URL: Documentation, https://github.com/yourusername/duckmail/blob/main/README.md
Project-URL: Repository, https://github.com/yourusername/duckmail
Project-URL: Issues, https://github.com/yourusername/duckmail/issues
Keywords: duckduckgo,email,cli,privacy,email-protection
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9.0
Requires-Dist: httpx>=0.24.0
Requires-Dist: keyring>=24.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pyperclip>=1.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-mock>=3.11.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.0.270; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Dynamic: license-file

# DuckMail CLI

Lightweight CLI for DuckDuckGo Email Protection - Manage your duck email addresses from the terminal.

**[English](README.md)** | [Tiếng Việt](README.vi.md)

---

## Quick Start

```bash
# Install
pip install -r requirements.txt
pip install -e .

# First time setup: Sign up via browser
# Visit https://duckduckgo.com/email/ to create account

# Login with your credentials
duckmail auth login

# Generate address and copy to clipboard
duckmail g -c
```

> **Note:** Account signup must be done via browser at https://duckduckgo.com/email/ due to DuckDuckGo's bot protection. After signing up, use the CLI to login and manage your addresses.

## Features

- 🔐 **Secure Authentication** - OTP-based login
- 📧 **Generate Addresses** - Create duck email addresses
- 📋 **Copy to Clipboard** - Auto-copy with `-c` flag
- ⚡ **Fast & Lightweight** - Quick commands with aliases
- 💾 **Secure Storage** - System keyring integration
- 🎨 **Beautiful Output** - Rich terminal UI

## Command Aliases

- `duckmail auth` → `duckmail a`
- `duckmail generate` → `duckmail g` or `duckmail gen`
- `duckmail info` → `duckmail i`

## Common Commands

```bash
# Authentication
duckmail auth login            # Login with username
duckmail auth logout           # Logout
duckmail auth status           # Check authentication status

# Generate
duckmail g                     # Generate 1 address
duckmail g -c                  # Generate & copy
duckmail g -n 5                # Generate 5 addresses

# Info
duckmail i                     # Account info
duckmail version               # Version
```

## Documentation

📖 **[Complete Documentation](DOCS.md)** - Full guide with:
- Installation instructions
- Usage examples
- API documentation
- Troubleshooting
- Command reference

## Project Structure

```
duckmail/
├── duckmail/              # Main package
│   ├── api/              # API clients
│   ├── config/           # Configuration
│   ├── utils/            # Utilities
│   └── cli.py            # CLI interface
├── DOCS.md               # Complete documentation
├── PLAN.md               # Project plan
├── README.md             # This file
└── requirements.txt      # Dependencies
```

## Development

```bash
# Setup
python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r requirements.txt
pip install -e .

# Run
duckmail --help
```

## License

MIT License - See [LICENSE](LICENSE) file

## Disclaimer

Unofficial tool, not affiliated with DuckDuckGo. Use at your own risk.

---

**Made with ❤️ for the DuckDuckGo community** 🦆
