Modern Python CLI for Nostr interactions - key generation, event creation, and relay management
Project description
⚡ Nostress
A modern, secure, and lightning-fast CLI for Nostr protocol interactions
Nostress empowers developers and Nostr enthusiasts with a powerful command-line interface for seamless key management, event creation, and relay interactions. Built with security-first principles and modern Python practices, it's the tool you've been waiting for to dive deeper into the decentralized web.
✨ Why Nostress?
🔐 Security First: Cryptographically secure key generation using industry-standard secp256k1 elliptic curve cryptography
⚡ Lightning Fast: Built with modern Python and optimized for performance with rich terminal interfaces
🛠️ Developer Friendly: Intuitive CLI with comprehensive help, JSON output, and scripting support
🔄 Format Flexible: Seamless conversion between hex and bech32 formats (nsec/npub)
🎨 Beautiful Output: Rich terminal formatting with tables, colors, and verbose modes
🚀 Quick Start
Installation
# Install via pip
pip install nostress
# Or using uv (recommended for development)
uv pip install nostress
# Verify installation
nostress --help
Your First Keypair
# Generate a new keypair (hex format)
nostress keys generate
# Generate in bech32 format with verbose output
nostress keys generate --format bech32 --verbose
# Generate both formats and save to file
nostress keys generate --format both --output my-keypair.txt
# JSON output for scripting
nostress keys generate --json
🔑 Core Features
Key Management Made Simple
Generate Secure Keypairs
# Basic generation
nostress keys generate
# Multiple formats
nostress keys generate --format both --verbose
# Encrypted storage
nostress keys generate --encrypt --output secure-key.txt
Validate Any Key
# Validate hex keys
nostress keys validate abc123...def
# Validate bech32 keys with type checking
nostress keys validate nsec1... --type nsec
nostress keys validate npub1... --type npub
Format Conversion (Coming Soon)
# Convert between formats
nostress keys convert nsec1... --to hex
nostress keys convert abc123... --to bech32 --type private
Advanced Features
- 🔒 Encryption Support: Password-protected key storage
- 📊 Rich Output: Beautiful tables and formatted displays
- 🤖 JSON Mode: Perfect for automation and scripting
- 🔍 Verbose Logging: Detailed operation insights
- 📁 File Operations: Save and load keys securely
🏗️ Architecture & Design
Nostress is built with a clean, modular architecture:
- CLI Layer: Intuitive command interface with Typer
- Core Logic: Cryptographic operations with the
cryptographylibrary - Utilities: Validation, formatting, and configuration management
- Rich Integration: Beautiful terminal output with colors and tables
Tech Stack
- Python 3.12+: Modern Python with type hints
- Typer: Powerful CLI framework with auto-completion
- Rich: Beautiful terminal formatting
- Cryptography: Industry-standard cryptographic operations
- Pydantic: Data validation and models
📖 Documentation
📚 For comprehensive documentation, tutorials, and API reference, visit our ReadTheDocs site
Quick Command Reference
# Main help
nostress --help
# Key management commands
nostress keys --help
# Specific command help
nostress keys generate --help
nostress keys validate --help
Configuration
Nostress follows XDG Base Directory standards for configuration:
- Config:
~/.config/nostress/ - Data:
~/.local/share/nostress/ - Cache:
~/.cache/nostress/
🛣️ Roadmap
Current Features (v0.1.x)
- ✅ Secure key generation (hex/bech32)
- ✅ Key validation and verification
- ✅ Rich terminal output and JSON support
- ✅ Encrypted key storage
Coming Soon (v0.2.x)
- 🔄 Format conversion between hex/bech32
- 📝 Event creation and signing
- 🔗 Relay connection management
- 🏪 Event publishing and querying
Future Plans (v1.0+)
- 📊 Advanced event filtering and search
- 🔐 Multi-signature support
- ⚡ Lightning integration
- 🕸️ Web interface companion
💖 Support the Project
Love Nostress? Support its development by sending some sats or connecting on Nostr!
⚡ Lightning Payments
Lightning Address: hberaud@nostrcheck.me
Scan to send lightning payments
Your support helps maintain and improve Nostress, ensuring it remains free and open-source for the entire Nostr community.
🫂 Follow on Nostr
Nostr Public Key: npub1azaaxhlx3v8lex2gnyxzq8ws9nxsh8ga30d64jeaqxw4e75vxufqm434ty
Scan to follow me on Nostr
Other Ways to Contribute
- 🌟 Star the repository to show your support
- 🐛 Report bugs and suggest features
- 💻 Contribute code via pull requests
- 📖 Improve documentation and examples
- 🗣️ Spread the word in the Nostr community
📄 License
Nostress is open-source software. Check the LICENSE file for details.
🤝 Contributing
We welcome contributions from the community! Whether it's:
- Bug fixes and improvements
- New features and commands
- Documentation updates
- Test coverage improvements
Please see our contribution guidelines and feel free to open issues and pull requests.
🔗 Connect
- Documentation: nostress.readthedocs.io
- GitHub: github.com/4383/nostress
- PyPI: pypi.org/project/nostress
- Lightning:
hberaud@nostrcheck.me - Nostr:
npub1azaaxhlx3v8lex2gnyxzq8ws9nxsh8ga30d64jeaqxw4e75vxufqm434ty
Built with ❤️ for the Nostr community
Nostress - Where cryptographic security meets developer experience
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nostress-0.1.0.tar.gz.
File metadata
- Download URL: nostress-0.1.0.tar.gz
- Upload date:
- Size: 700.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbbe7da1dd8747e338b281cd0476358bcb758c70bc145c3d500c4f321e58182c
|
|
| MD5 |
9526e5462310ed790952e3617751f207
|
|
| BLAKE2b-256 |
071b201d898eff90d99109af45dec698eae688fe1c0aff9dbe3feadf7866437e
|
File details
Details for the file nostress-0.1.0-py3-none-any.whl.
File metadata
- Download URL: nostress-0.1.0-py3-none-any.whl
- Upload date:
- Size: 26.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3bce394b7a26df25af81bdfd40d84cf05cdb4401c54927d7776dfab81528bbfb
|
|
| MD5 |
ef5c324e1986640e7f01decec39ec3b4
|
|
| BLAKE2b-256 |
deae5c351ec5d45ee6f38faffc808bf643bfbd65437075ea515ff7be6cbb7837
|