relikd/botlib
1
0
Fork 0
Code Issues Pull Requests Releases Activity

update readme

Browse Source
This commit is contained in:
relikd
2022-04-08 21:00:49 +02:00
parent e871e6f03e
commit a25b62d934
2 changed files with 57 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -5,13 +5,13 @@ A collection of scripts to parse and process input files (html, RSS, Atom) – w
<sup>1</sup>: Well, except for `pytelegrambotapi`, but feel free to replace it with another module.
Includes tools for extracting “news” articles, detection of duplicates, content downloader, cron-like repeated events, and Telegram bot client.
Basically everything you need for quick and dirty format processing (html->RSS, notification->telegram, rss/podcast->download, webscraper, ...) without writing the same code over and over again.
The architecture is modular and pipeline processing oriented.
Basically everything you need for quick and dirty format processing (`html->RSS`, `notification->telegram`, `rss/podcast->download`, `web scraper`, ...) without writing the same code over and over again.
The architecture is modular and pipeline oriented.
Use whatever suits the task at hand.
### In progress
## Usage
Documentation, examples, tests and `setup.py` will be added soon.
Meanwhile, take a look at the [Usage](botlib/README.md) documentation.
There is a short [usage](./botlib/README.md) documentation on the individual componentes of this lib.
And there are some [examples](./examples/) on how to combine them.
Lastly, for web scraping, open the [playground.py](./examples/web-scraper/playground.py) to test your regex.