RcGcDb/README.md

24 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2020-07-23 19:12:07 +00:00
## Introduction
2020-11-30 17:52:26 +00:00
RcGcDb is a backend for handling Discord webhooks to which recent changes of MediaWiki wikis are being pushed to.
Master branch shouldn't be used in production and there are no guarantees for it working fine. It's mostly being created to work with [Wiki-Bot](https://github.com/Markus-Rost/discord-wiki-bot/).
2024-09-12 19:19:40 +00:00
If you are looking for low-scale MW Discord webhook recent changes solution, look at [RcGcDw](https://gitlab.com/chicken-riders/RcGcDw) which should be more production ready.
2020-11-30 17:52:26 +00:00
MRs are still welcome.
2020-07-23 19:12:07 +00:00
### Dependencies ###
2020-11-30 17:52:26 +00:00
* **Python 3.7+**
* beautifulsoup 4.6.0+
* aiohttp 3.6.2+
* lxml 4.2.1+
* nest-asyncio 1.4.0+
2020-07-23 19:12:07 +00:00
#### Installation
```
$ git clone git@gitlab.com:chicken-riders/rcgcdb.git #clone repo
2020-07-25 13:27:15 +00:00
$ cd RcGcDb
2020-07-23 19:12:07 +00:00
$ python3 -m venv . #(optional, if you want to contain everything (you should!))
$ source bin/activate #(optional, see above)
$ pip3 install -r requirements.txt #install requirements (lxml may require additional distro packages, more on that here https://lxml.de/build.html)
$ nano settings.json.example #edit the configuration file
$ mv settings.json.example settings.json
$ python3 start.py
```