summaryrefslogtreecommitdiff
path: root/README.md
blob: 0931c742a85cb4e4e0eb5149c86b66f5f58bfad8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# nostrpy

A python library and reference CLI tool implementing the [nostr](https://github.com/fiatjaf/nostr/) protocol. Still very much a work in progress.

- [x] BIP-340 Schnorr signatures using the reference Python implementation
- [ ] Complete Pythonic API for the nostr protocol
- [ ] Reference CLI tool implementing the nostr client and server

Supports Python 3.7 and up.

## Usage

```bash
$ pip install nostr
```

## Dev

For development it's best to use `pipenv`:

```bash
$ pipenv install -d
$ pipenv run test
```