Nostress Documentation¶
Nostress is a modern Python CLI for Nostr protocol interactions, providing key generation, event creation, and relay management capabilities.
Contents:
- Installation
- Quick Start
- CLI Reference
- API Reference
- Architecture
- Contributing
- How to Contribute
- Getting Started
- Development Commands
- Testing Infrastructure
- GitHub Actions CI Pipeline
- Code Standards
- Reporting Issues
- Pull Request Guidelines
- Development Guidelines
- Troubleshooting
- Security Considerations
- Community
- Recognition
- Getting Help
- Development Environment Tips
- Support the Project
Overview¶
Nostress provides a clean, secure interface for interacting with the Nostr protocol. Built with modern Python practices, it offers:
Secure Key Management: Generate and manage Nostr keypairs with cryptographically secure methods
Format Support: Handle both hexadecimal and bech32 key formats
Rich CLI Interface: Intuitive command-line interface with verbose output options
Extensible Architecture: Well-structured codebase ready for additional Nostr features
Key Features¶
- 🔐 Cryptographic Operations
Secure key generation using the cryptography library with secp256k1 elliptic curve support.
- 🎨 Rich Output
Beautiful terminal output with tables, JSON formatting, and progress indicators.
- ⚙️ Modern Python
Built for Python 3.12+ with type hints, Pydantic models, and comprehensive testing.
- 🔧 Developer Friendly
Extensive documentation, clear architecture, and ready for extension.
Quick Start¶
Installation:
uv pip install nostress
Generate your first keypair:
nostress keys generate
See the full output with verbose mode:
nostress keys generate --verbose
Get help:
nostress --help
nostress keys --help
Support & Community¶
Lightning Support ⚡
Support the development of Nostress with Lightning payments:
Connect on Nostr 🔗
Follow and connect with the project on the decentralized Nostr network:
Contact: hberaud@nostrcheck.me