doesnm/Rivista
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Update instructions;

Browse source 
Improve handling of a single item;
Add references to syndication software.
This commit is contained in:
Schimon Jehudah, Adv. 2024-07-09 15:29:22 +03:00
parent 12ecdac878
commit 53c6c946ca
11 changed files with 2270 additions and 276 deletions
Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -21,14 +21,28 @@ This software was inspired from Tigase and was motivated by Movim.
## Installation
### Download
Extract the source package to a directory that you have permission to run
software.
Execute with one of the followings:
```shell
$ git clone https://git.xmpp-it.net/sch/PubSubToAtom
$ cd PubSubToAtom/
```
### Configure
Add account credentials to file `configuration.toml`.
### Start
Execute PubSubToAtom with one of the following commands:
```shell
$ uvicorn pubsub_to_atom:app --host 127.0.0.1 --port 8000
$ python -m uvicorn pubsub_to_atom:app --reload
$ python -m uvicorn pubsub_to_atom:app --reload --host 127.0.0.1 --port 8000
$ uvicorn pubsub_to_atom:app --host 127.0.0.1 --port 8000
$ fastapi dev pubsub_to_atom.py
```
@ -36,22 +50,26 @@ $ fastapi dev pubsub_to_atom.py
It is possible to view a complete node and even a single item, which means, that it is possible to save bandwidth and it further means that a considered and carefully earnest use of this software would saves system overhead, which includes CPU, I/O and RAM usage.
### Viewing node items
### Viewing PubSub
|PubSub |Node |
|--- |--- |
|xmpp:pubsub.movim.eu|berlin-xmpp-meetup|
Suppose you have the following nodes and items.
URL: http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup
|PubSub |Node |Item |
|--- |--- |--- |
|blog.jmp.chat |urn:xmpp:microblog:0|launch-2023 |
|news.movim.eu |Phoronix | |
|pubsub.movim.eu|berlin-xmpp-meetup |let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4|
#### To view node items
### Viewing a node item
- http://127.0.0.1:8000/atom?pubsub=news.movim.eu&node=Phoronix
- http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup
|PubSub |Node |Item |
|--- |--- |--- |
|xmpp:pubsub.movim.eu|berlin-xmpp-meetup|let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4|
#### To view a node item
URL: http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup&item=let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4
- http://127.0.0.1:8000/atom?pubsub=blog.jmp.chat&node=urn%3Axmpp%3Amicroblog%3A0&item=launch-2023
- http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup&item=7363a41d-1146-40b3-ac0f-8ee2559591a3
- http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=berlin-xmpp-meetup&item=let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4
## Author
@ -71,6 +89,6 @@ Special thanks to "d3x" and "cchianel" from IRC channel #python on irc.libera.ch
## Similar Projects
* [AtomEntry](https://github.com/tigase/sureim/blob/master/site/src/main/java/tigase/sure/web/site/client/pubsub/AtomEntry.java) and [PubSubPublishViewImpl.java](https://github.com/tigase/sureim/blob/master/site/src/main/java/tigase/sure/web/site/client/pubsub/PubSubPublishViewImpl.java)- Convert XMPP Pubsub Nodes to Atom Syndication Format and convey them over HTTP.
* [AtomEntry](https://github.com/tigase/sureim/blob/master/site/src/main/java/tigase/sure/web/site/client/pubsub/AtomEntry.java) and [PubSubPublishViewImpl](https://github.com/tigase/sureim/blob/master/site/src/main/java/tigase/sure/web/site/client/pubsub/PubSubPublishViewImpl.java)- Convert XMPP Pubsub Nodes to Atom Syndication Format and convey them over HTTP.
* [AtomToPubsub](https://github.com/edhelas/atomtopubsub) - A little client that parses Atom + RSS feeds and send them on XMPP Pubsub Nodes.