sch/Rivista
2
1
Fork 1
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions
Rivista/README.md
sch 3724eaa0a8 Update README.md 
Update paths to screenshots.
2024-11-12 14:37:40 +01:00

212 lines
8.4 KiB
Markdown
Raw Blame History

# Rivista XJP
Rivista XJP ("XMPP Journal Publisher"); previously XMPP PubSub To Atom ("XPTA").
Rivista is a software that parses XMPP Pubsub Nodes and sends them as Atom
Syndication Format or OPML over HTTP.
Rivista 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)).
Rivista includes [XSLT ](https://www.w3.org/TR/xslt/) stylesheets that transform
PubSub nodes into static XHTML journal sites.
Rivista was inspired from Tigase and was motivated by Movim.
## Instances
* https://rivista.woodpeckersnest.eu
## Preview
[<img alt="berlin-xmpp-meetup" src="rivista/screenshot/berlin-xmpp-meetup.png" width="200px"/>](rivista/screenshot/berlin-xmpp-meetup.png)
[<img alt="let-s-talk-about-xmpp-tricks-with-conversations-author-daniel-gultsch-OqjaQh" src="rivista/screenshot/let-s-talk-about-xmpp-tricks-with-conversations-author-daniel-gultsch-OqjaQh.png" width="200px"/>](rivista/screenshot/let-s-talk-about-xmpp-tricks-with-conversations-author-daniel-gultsch-OqjaQh.png)
[<img alt="59d860ab-d7c8-477c-bb4b-86924485cbbb" src="rivista/screenshot/59d860ab-d7c8-477c-bb4b-86924485cbbb.png" width="200px"/>](rivista/screenshot/59d860ab-d7c8-477c-bb4b-86924485cbbb.png)
[<img alt="selection" src="rivista/screenshot/selection.png" width="200px"/>](rivista/screenshot/selection.png)
## Motivation
Rivista is a syndication project which makes journals and publications that are
hosted on XMPP PubSub nodes, available from HTTP to both, XML news readers and
even HTML browsers.
This means that instead of hosting a journal or publication site in the old
fashion (i.e. HTML documents hosted on an HTTP server), one only has to have an
HTTP server to operate Rivista, and the rest of the content is delivered from an
XMPP server (i.e. PubSub nodes).
The project also showcases the non-necessity of HTML, as it automatically
generates valid XHTML pages by HTML browsers (client-side) from XSLT
stylesheets.
Because Rivista reads XMPP PubSub nodes, it is possible to view a complete set
of node items, and even a single node item, which means, that a considered and
carefully earnest use of Rivista would save bandwidth and system overhead, which
includes CPU, I/O and RAM usage.
## Requirements
* Python >= 3.5
* beautifulsoup4
* fastapi
* lxml
* markdown
* slixmpp
* tomllib (Python <= 3.10)
* uvicorn
## Installation
It is possible to install Rivista using pip and pipx.
#### pip inside venv
```
$ python3 -m venv .venv
$ source .venv/bin/activate
```
##### Install
```
$ pip install git+https://git.xmpp-it.net/sch/Rivista
```
#### pipx
##### Install
```
$ pipx install git+https://git.xmpp-it.net/sch/Rivista
```
##### Update
```
$ pipx uninstall rivista
$ pipx install git+https://git.xmpp-it.net/sch/Rivista
```
### Configure
Add account credentials to file `settings.toml`.
Copy file`settings.toml` to `~/.config/rivista/`.
Copy directories `css`, `graphics`, `img`, `script`, and `xsl` to
`~/.local/share/rivista/`.
Copy directory `json` to `~/.cache/rivista/`.
### Start
```
$ rivista
```
## Usage
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 save system overhead, which
includes CPU, I/O and RAM usage.
### Viewing PubSub
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.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/opml?pubsub=news.movim.eu
http://127.0.0.1:8000/opml?pubsub=pubsub.woodpeckersnest.space
```
#### To view node 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
```
#### To view a node item
```
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=edhelas%40movim.eu&node=urn%3Axmpp%3Amicroblog%3A0&item=working-on-launching-the-movim-network-qPBzwc
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
- [XEP-0060: Publish-Subscribe](https://xmpp.org/extensions/xep-0060.html)
- [XEP-0277: Microblogging over XMPP](https://xmpp.org/extensions/xep-0277.html)
- [XEP-0472: Pubsub Social Feed](https://xmpp.org/extensions/xep-0472.html)
## Author
Schimon Jehudah Zackary
## License
CSS and XSLT stylesheets are licensed under the license MIT.
JS scripts are licensed under the license MIT.
Python code is licensed under the license AGPL-3.0 only.
## Acknowledgement
Thank you to Mr. Peter Saint-Andre ([stpeter](https://stpeter.im/journal/731.html))
for manifesting [Atom Over XMPP](https://www.ietf.org/archive/id/draft-saintandre-atompub-notify-07.html).
Thank you to Mr. Wojtek and [Tigase](https://tigase.org/) for publicly exposing
an implementation of PubSub as Syndication at [Sure.IM](https://sure.im/) as
[feeds.tigase.im](http://feeds.tigase.im/atom?server=pubsub@sure.im&node=news).
Thank you to to Mr. Timothée Jaussoin ([edhelas](https://edhelas.movim.eu/)) who
consistently and earnestly showcases the potential of PubSub as a publication
platform with project [Movim](https://movim.eu/).
A special thank you to the gentlemen "d3x" and "cchianel" from IRC channel
#python on irc.libera.chat for initial references concerning code, servers and
FastAPI.
And an important thank you to Mr. Simone Canaletti
([roughnecks](https://blog.woodpeckersnest.space)) for testing and deploying
Rivista into production.
## Similar Projects
* [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.
# Home site
- https://schapps.woodpeckersnest.eu/rivista/
- gemini://woodpeckersnest.space/~schapps/rivista.gmi
Reference in a new issue View git blame Copy permalink