From 1138faceda704eddebd35626a22026c0d985ec50 Mon Sep 17 00:00:00 2001 From: "Schimon Jehudah, Adv." Date: Fri, 12 Jul 2024 18:27:21 +0300 Subject: [PATCH] Add more examples to README and update information. --- README.md | 38 ++++++++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d4d59f2..4327faa 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ XMPP Journal Publisher ("XJP") is a software that parses XMPP Pubsub Nodes and s XJP generates Atom syndication feeds ([RFC 4287](https://www.rfc-editor.org/rfc/rfc4287)) from XMPP PubSub nodes ([XEP-0060](http://xmpp.org/extensions/xep-0060.html)). -XJP includes [XSLT ](https://www.w3.org/TR/xslt/) stylesheets that transforms PubSub nodes into static XHTML journal sites. +XJP includes [XSLT ](https://www.w3.org/TR/xslt/) stylesheets that transform PubSub nodes into static XHTML journal sites. XJP was inspired from Tigase and was motivated by Movim. @@ -32,10 +32,9 @@ Because XMPP Journal Publisher reads XMPP PubSub nodes, it is possible to view a * Python >= 3.5 * fastapi -* feedgenerator * lxml * slixmpp -* tomllib +* tomllib (Python <= 3.10) * uvicorn ## Installation @@ -64,6 +63,7 @@ Add account credentials to file `configuration.toml`. Execute XMPP Journal Publisher with one of the following commands: ```shell +$ python -m uvicorn main:app --reload $ 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 @@ -78,15 +78,25 @@ It is possible to view a complete node and even a single item, which means, that Suppose you have the following PubSub nodes and items. -|Jabber ID |Node |Item | -|--- |--- |--- | -|blog.jmp.chat |urn:xmpp:microblog:0|launch-2023 | -|edhelas%40movim.eu|urn:xmpp:microblog:0|working-on-launching-the-movim-network-qPBzwc | -|goffi%40goffi.org |urn:xmpp:microblog:0|libervia-v0-8-la-cecilia-BdQ4 | -|news.movim.eu |Phoronix | | -|pubsub.movim.eu |berlin-xmpp-meetup |7363a41d-1146-40b3-ac0f-8ee2559591a3 | -|pubsub.movim.eu |berlin-xmpp-meetup |let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4| -|pubsub%40sure.im |news | | +|Jabber ID |Node |Item | +|--- |--- |--- | +|blog.jmp.chat |urn:xmpp:microblog:0 |launch-2023 | +|edhelas%40movim.eu |urn:xmpp:microblog:0 |working-on-launching-the-movim-network-qPBzwc | +|goffi%40goffi.org |urn:xmpp:microblog:0 |libervia-v0-8-la-cecilia-BdQ4 | +|news.movim.eu |Phoronix | | +|pubsub.movim.eu |berlin-xmpp-meetup |7363a41d-1146-40b3-ac0f-8ee2559591a3 | +|pubsub.movim.eu |berlin-xmpp-meetup |let-s-talk-about-the-xsf-and-possibly-other-things-6A8eV4 | +|pubsub.movim.eu |jesus-christ-son-of-god|the-passion-of-christ-redemption-and-salvation-for-all-who-believe-moSqXO| +|pubsub.woodpeckersnest.space|PlanetJabber | | +|pubsub.woodpeckersnest.space|xmpp-it | | +|pubsub%40sure.im |news | | + +#### To view pubsub nodes + +``` +http://127.0.0.1:8000/atom?pubsub=news.movim.eu +http://127.0.0.1:8000/atom?pubsub=pubsub.woodpeckersnest.space +``` #### To view node items @@ -94,6 +104,9 @@ Suppose you have the following PubSub nodes and items. http://127.0.0.1:8000/atom?pubsub=edhelas%40movim.eu&node=urn%3Axmpp%3Amicroblog%3A0 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 +http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=jesus-christ-son-of-god +http://127.0.0.1:8000/atom?pubsub=pubsub.woodpeckersnest.space&node=PlanetJabber +http://127.0.0.1:8000/atom?pubsub=pubsub.woodpeckersnest.space&node=xmpp-it http://127.0.0.1:8000/atom?pubsub=pubsub%40sure.im&node=news ``` @@ -105,6 +118,7 @@ http://127.0.0.1:8000/atom?pubsub=edhelas%40movim.eu&node=urn%3Axmpp%3Amicroblog http://127.0.0.1:8000/atom?pubsub=goffi%40goffi.org&node=urn%3Axmpp%3Amicroblog%3A0&item=libervia-v0-8-la-cecilia-BdQ4 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 +http://127.0.0.1:8000/atom?pubsub=pubsub.movim.eu&node=jesus-christ-son-of-god&item=the-passion-of-christ-redemption-and-salvation-for-all-who-believe-moSqXO ``` ## Supported XEPs