Metadata-Version: 2.4
Name: plume-nostr
Version: 0.1.1
Summary: A tool to sign and verify files using Nostr. Think GPG, but user-friendly
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: electrum-ecc
Requires-Dist: electrum-aionostr
Requires-Dist: pycryptodomex
Requires-Dist: aiohttp-socks
Requires-Dist: certifi
Requires-Dist: platformdirs
Dynamic: license-file

# Plume - Nostr File Authenticity Tool

A tool to sign and verify files using Nostr. Think GPG, but user-friendly.

Instead of sharing .asc files, file signatures are stored on Nostr relay servers. 
Verification requires only the file itself and the trusted signer's public key, 
accessible via a simple GUI or the CLI

![screencast](https://github.com/user-attachments/assets/15a2df6b-d5ba-44fb-85a9-6bca3dacb747)

## Features
* File signing
* File verification
* Connecting through SOCKS proxy
* Graphical- and Command Line Interface

## Installation

### PyPI

```sh
pip install plume-nostr
```

### Source

```sh
git clone https://github.com/f321x/plume
cd plume
pip install -e .
```

## Usage

### GUI

```sh
plume
```

### CLI

#### Sign

```sh
plume-cli sign file.txt --key nsec1...
```

#### Verify

```sh
plume-cli verify file.txt
```

#### Config

```sh
plume-cli config --list
plume-cli config --add-relay wss://relay.damus.io
plume-cli config --add-trusted npub1...
```
