Add file PyProject;

Support display of a single pubsub node item;
Update document README;
Modularize code;
This commit is contained in:
Schimon Jehudah, Adv. 2024-11-17 17:30:38 +02:00
parent 37aa7e8f40
commit 5e495579c2
32 changed files with 2431 additions and 2059 deletions

View file

@ -73,15 +73,57 @@ JabberCard requires an XMPP account to work, it only needs an XMPP server.
- XEP-0060: Publish-Subscribe
- XEP-0292: vCard4 Over XMPP
## Install
## Installation
Use the following commands, to begin JabberCard.
It is possible to install JabberCard using pip and pipx.
#### pip inside venv
```shell
git clone https://git.xmpp-it.net/sch/JabberCard
cd JabberCard/
python -m uvicorn fasi:app
```
$ python3 -m venv .venv
$ source .venv/bin/activate
```
##### Install
```
$ pip install git+https://git.xmpp-it.net/sch/JabberCard
```
#### pipx
##### Install
```
$ pipx install git+https://git.xmpp-it.net/sch/JabberCard
```
##### Update
```
$ pipx reinstall jabbercard
```
```
$ pipx uninstall jabbercard
$ pipx install git+https://git.xmpp-it.net/sch/JabberCard
```
### Configure
Copy file `settings.toml` to `~/.config/jabbercard/`.
Copy directories `css`, `img`, and `template` to `~/.local/share/jabbercard/`.
Copy files `clients.toml`, and `systems.toml` to `~/.local/share/jabbercard/`.
### Start
```
$ jabbercard
```
Open URL http://localhost:8000 and connect with your Jabber ID.
## License
@ -101,7 +143,7 @@ Schimon Jehudah Zachary 2024
## Thanks
A special thank you for Mr. Georg Lukas of [op-co.de](https://op-co.de/) from
A special thank you for Mr. Georg Lukas of [op-co.de](https://op-co.de) from
Germany, who has gracefully published a sophisticated client-side HTML
invitation page, and consequently exposed that idea to the founder of this
project.