nostrpy 0.2.1

Python CLI for Nostr

nostrpy

CI/CD

---

CLI for Nostr

Installation

❯ pip install nostrpy

Usage

Show nostr version

❯ nostr --version
nostr, version 0.0.3.dev5+g649c474.d20230212

Generate a key pair

❯ nostr key create
Private key: nsec18ty...2xz6
Public key: npub1rak...58cm

Transform a public key to hex format

❯ nostr key npub-to-hex --pub-key npub1rak...58cm
npub: npub1rak...58cm
hex: 1f6cada4...449d

Publish a message

❯ nostr message publish -s <the sender nsec key> -m "Hello, publishing a message through nostr CLI."

Send an encryped direct message

❯ nostr message send -s <the sender nsec key> -m "Hello, sending an encryped direct message" -p <the receiver npub key>

Receive message(s)

❯ nostr message receive -p <the npub key to receive the messages>
Hello, publishing a message through nostr CLI.
...

Development & Test

See the Test Suite README

Feel free to add issues, add PRs, or provide any feedback!

Credits

Repositories:

• https://github.com/jeffthibault/python-nostr
• https://github.com/BrightonBTC/bija
• https://github.com/holgern/pynostr