eteaching.plone.nostrmetadatasync 1.0.0a0

A addon for syncing metadata with nostr

eteaching.plone.nostrmetadatasync

Nostr integration for Plone.

eteaching.plone.nostrmetadatasync synchronises metadata of Plone contents with Nostr. This is done on the basis of subscribers (event handlers). When content is created, deleted or modified on the Plone website, corresponding Nostr events are created, signed and sent to predefined relias in the Nostr network. Two control panels are also provided. One is for settings, where you can specify which content types and filters should be used to select the content affected by synchronization. The second control panel can be used to create all events in the Nostre relays for the entire content selected using the settings, or to send delete events.

Features

• Synchronizes metadata of event based objects (e.g. plone.app.event) with Nostr Time-Based Calendar Event (NIP-52)
• Synchronizes metadata of objects with Nostr AMB Event (NIP-AMB)

Installation

Prerequisites ✅

• An operating system that runs all the requirements mentioned.
• uv
• Make
• Git
• Docker (optional)

Install eteaching.plone.nostrmetadatasync with pip

1. Install

   pip install eteaching.plone.nostrmetadatasync
   

2. Create the Plone site

   make create-site
   

3. Start the Plone site

   make start
   

Install eteaching.plone.nostrmetadatasync with git 🔧

1. Clone this repository, then change your working directory

   git clone [e-mail]:e-teachingorg/eteaching.plone.nostrmetadatasync.git
   cd eteaching.plone.nostrmetadatasync
   

2. Create environment

   python3.12 -m venv .
   bin/pip install uv
   source bin/activate
   

3. Create an .env file to set NOST_KEY as an environment variable.

   vi .env
   

   NOSTR_KEY=MyPrivateNostrKey
   

4. Install the code base

   make install
   

5. Create the Plone site

   make create-site
   

6. Start

   make start
   

Install eteaching.plone.nostrmetadatasync via buildout

1. Add the following to buildout.cfg:

   [buildout]
   
   ...
   
   eggs =
       eteaching.plone.nostrmetadatasync
   

2. Run buildout

   bin/buildout	
   

3. Start

   bin/instance fg
   

Contribute

• Issue tracker
• Source code

License

The project is licensed under the GPLv2.