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

Modularize code;

Browse source 
Add packaging instructions;
Add modules to handle Gemini file type (no Gemini server yet);
Improve handling of configuration.
This commit is contained in:
Schimon Jehudah, Adv. 2024-11-12 15:25:05 +02:00
parent 84e54085b5
commit 766e51af4c
46 changed files with 2359 additions and 663 deletions
Download patch file Download diff file Expand all files Collapse all files

122
README.md
View file

@ -1,18 +1,22 @@
# Rivista
# Rivista XJP
Previously, XMPP Journal Publisher ("XJP") and XMPP PubSub To Atom ("XPTA").
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 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 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 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/
* https://rivista.woodpeckersnest.eu
## Preview
@ -23,60 +27,90 @@ Rivista was inspired from Tigase and was motivated by Movim.
## 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.
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).
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.
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.
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
### Debian-based Distro
It is possible to install Rivista using pip and pipx.
```shell
# apt install python3 python3-fastapi python3-feedgenerator python3-lxml python3-slixmpp python3-tomli uvicorn
#### pip inside venv
```
$ python3 -m venv .venv
$ source .venv/bin/activate
```
### Download
##### Install
Extract the source package to a directory that you have permission to run software.
```
$ pip install git+https://git.xmpp-it.net/sch/Rivista
```
```shell
$ git clone https://git.xmpp-it.net/sch/Rivista
$ cd 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 `configuration.toml`.
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
Execute Rivista 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
$ fastapi dev pubsub_to_atom.py
```
$ 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.
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
@ -145,18 +179,34 @@ 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. 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 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/).
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.
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.
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.
* [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.
* [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