Merge branch 'main' into release

Author: b-simjoo

.gitattributes

@@ -1,2 +1,3 @@
 README.md merge=ours
-Docs/ merge=ours
+Docs/ merge=ours
+config merge=ours

.gitignore

@@ -128,7 +128,10 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-.db/
+.vscode/
+db/
+db.lmdb/
 *.mdb
 strings.json
-bugs.json
+bugs.json
+user-config.conf

Bug-reporter.conf

@@ -0,0 +1,4 @@
+[global]
+server.socket_host = '0.0.0.0'
+server.socket_port = 7191
+log.screen = False

BugReporter.py

@@ -8,15 +8,18 @@ def __init__(self, data:dict):
         if data.get('commit') == commit:
             self.data = data
         else:
-            self.data = {'commit':commit, 'tags':dict(), 'bugs_count':0}
+            self.data = {'commit':commit, 'tags':dict(), 'bugs_count':0, 'build':'passing'}
 
-    def bug(self, tag, message=None):
+    def bug(self, tag, message=None, custom_prop={}):
         tags = self.data['tags']
         current_tag = tags.get(tag, {'count':0})
         current_tag['count'] += 1
         current_tag['message'] = message
+        current_tag['custom-prop'] = custom_prop
         tags[tag] = current_tag
         self.data['bugs_count'] = len(tags)
+        if len(tags):
+            self.data['build']='failing'
 
 class BugReporter:
     def __init__(self, file_path = 'bugs.json'):

Docs/build failing.svg

@@ -3,19 +3,18 @@
  <h1 align="center">Telegram RSS Bot</h1>
  <p align="center">
  <a href="http://de1.hashbang.sh:7191">
-  <img alt="" src="http://de1.hashbang.sh:7191/build_state">
+  <img alt="" src="https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=build&query=$.Telegram_RSS_Bot.build&color=white">
+  <img alt="Reported bugs from pcworms_bot project" src="https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=Bugs+found&query=$.Telegram_RSS_Bot.bugs_count&color=red">
  </a>
  <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/labels/bug">
   <img alt="Bug issue" src="https://img.shields.io/github/issues-raw/bsimjoo/Telegram-RSS-Bot/bug?color=red">
  </a>
- <a href="http://de1.hashbang.sh:7191">
-  <img alt="Reported bugs from pcworms_bot project" src="https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=Bugs+found&query=$.Telegram_RSS_Bot.bugs_count&color=red">
- </a>
  <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/labels/todo">
   <img src="https://img.shields.io/github/issues-raw/bsimjoo/Telegram-RSS-Bot/todo?color=orange&label=TODOs">
  </a>
  <a href="https://github.com/bsimjoo/Telegram-RSS-Bot/releases">
   <img src="https://img.shields.io/github/v/release/bsimjoo/Telegram-RSS-Bot">
+  <img alt="GitHub release (latest SemVer including pre-releases)" src="https://img.shields.io/github/v/release/bsimjoo/Telegram-RSS-Bot?include_prereleases&label=pre-release">
  </a>
  <a href="LICENSE.md">
   <img src="https://img.shields.io/github/license/bsimjoo/Telegram-RSS-Bot">
@@ -41,7 +40,7 @@ Owner (bot call him as lord!) can identify himself using the token he got from @
 ### Owner can:
 - Generate one-time tokens and add admins. (No remove option at now)
 - Get muted notification of bot join/kick from a GP or channel.
-- Get notification of Errors and Exceptions (usefull for report to me).
+- Get notification of Errors and Exceptions (useful for report to me).
 - What Others (Admins and users) can do.
 
 ## Admin
@@ -56,15 +55,15 @@ Then Owner Receive a message with admin information and accept/decline button.
 - Send photo, markdown or simple text messages to all chats
 - Send last feed to all chats
 - Get bot statistics (chats, members and admins count)
-- Get a list of all chats with username, fullname and ... (except profile photo and phone number)
+- Get a list of all chats with username, full-name and ... (except profile photo and phone number)
 - Change the interval between each check for a new post
 
 ### Users can:
 - Get last feed
 - *No more option*
 
 ---
-`/help` command will give you a list of all available command related to user level.
+`/help` command will give you a list of all available command related to your access.
 
 # Languages
 Available languages:
@@ -76,41 +75,45 @@ You can translate [default-strings.json](default-strings.json) file to add more
 **Notice** Rename you custom strings file to `strings.json` to prevent git pull errors. (`strings.json` is ignored for your custom version)
 
 # Installation:
-First of all admin need to create a new bot using telegram @BotFather and keep Bot-Token safe. then Download Comprressed Source or use git clone
+First of all admin need to create a new bot using telegram @BotFather and keep Bot-Token safe. then Download Compressed Source or use git clone
 ```bash
 git clone https://github.com/bsimjoo/Telegram_RSS_bot.git
 ```
 
 Change working directory to source directory and install requirements using this commands:
-```
+```bash
 cd ./Telegram_RSS_Bot
 python3 -m pip install --user -r requirements.txt
 ```
 wait until installation finish without any error. (You can report errors to me)
 
-Then configure and run the server for first use.
-```
-python3 main.py -t {bot-token-here} -s {source-here} -l {language}
+Then configure server. this repository may update `config-example.conf`, but `user-config.conf` is ignored and it is for users
+```bash
+cp config-example.conf user-config.conf
 ```
-The program will save the configurations for reuse in the database, so you do not need to reconfigure the server for the next run, unless you need to change them.
+Edit `user-config.conf` with a text editor, if you want to know about Bug-Reporter [see Bug reporter below](#bug-reporter--)
 
+Then run server
+```bash
+python3 main.py
+```
 Identify yourself as owner to bot. you can start a chat with your bot and then use this:
 ```
 /start {bot-token}
 ```
 
 # Reset databases
-If your about to reset database you can use `-r {database}` to reset `chats`, `config` or `all` databases.
+If your about to reset database you can use `-r {database}` to reset `chats`, `data` or `all` databases.
 
-**:warning: This action can not be undone**
+<b>:warning: <font color="orange">This action can not be undone</font></b>
 
-# Bug Reporter
-I added a module that reports exceptions or any custom message and counts them, then I can show the number of bugs through a running server and then track and fix them. The bug reporter is not enabled by default, but if you are interested you can save the bugs to a local file `bug.json` by running the server with the `-b` argument, or run the bug report http server with `-b {port number}` to see them through an http server (click on the "Bugs found" badge to see an example).
+# Bug Reporter [![Bugs](https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=Bugs+found&query=$.Telegram_RSS_Bot.bugs_count&color=red) ![build](https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=build&query=$.Telegram_RSS_Bot.build&color=white)](http://de1.hashbang.sh:7191)
+I wrote a module that reports exceptions or any custom message and counts them, then I can show the number of bugs of a running server and then track and fix them. The bug reporter is off by default, but if you are interested you can save the bugs to a local file `bugs.json` in offline mode, or run the bug report http server in online mode to see them through an http server (click on [![Bugs](https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=Bugs+found&query=$.Telegram_RSS_Bot.bugs_count&color=red) or ![build](https://img.shields.io/badge/dynamic/json?url=http://de1.hashbang.sh:7191/json&label=build&query=$.Telegram_RSS_Bot.build&color=white)](http://de1.hashbang.sh:7191) badge to see an example). The default configuration of the http bug reporter is saved in `Bug-reporter.conf` but you can config server to use your own config file.
 
-**Notice** Don't forget to install `cherrypy` for online bug reporter using `python3 -m pip install cherrypy`
+**Notice** Don't forget to install `cherrypy` before using http bug reporter. use `python3 -m pip install cherrypy`
 
 ---
 Using [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) api
 
 ###### this is my first telegram bot!
-this project began for [pcworms.blog.ir](http://pcworms.blog.ir) weblog, but now it is available for everyone. you can see customised version at [pcworms/PCworms_Bot](https://github.com/pcworms/PCworms_Bot)
+this project began for [pcworms.blog.ir](http://pcworms.blog.ir) weblog, but now it is available for everyone. you can see customized version at [pcworms/PCworms_Bot](https://github.com/pcworms/PCworms_Bot)

Docs/build passing.svg

@@ -0,0 +1,26 @@
+[main]
+# in telegram use @botfather to create a bot and then paste token here
+token = your bot token
+
+source = https://pcworms.blog.ir/rss/
+language = en-us
+strings-file = Default-strings.json
+log-level = info
+
+# specify path of file based database [CRITICAL]
+db-path = db.lmdb
+
+# uncomment to save logs to file instead of console output
+# log-file = log.log
+
+bug-reporter = off
+# bug reporter modes: 
+#   off      Disable bug-reporter
+#   offline  Saves bugs in bugs-file
+#   online   Saves bugs in file and also runs a http server, you can configure
+#            HTTP-server (using cherrypy) in [bug-reporter] section
+# if you're going to run bug-reporter in online mode, make sure you have cherrypy installed
+# or use "python3 -m pip install cherrypy" to install it
+# bugs file needed if bug-reporter is not off
+bugs-file = ./bugs.json
+reporter-config-file = Bug-reporter.conf

README.md

@@ -1,13 +1,13 @@
 {
     "en-us":{
-        "wellcome": [
+        "welcome": [
             "Hi, I'm open\\-source [telegram RSS bot](https://github.com/bsimjoo/Telegram_RSS_bot) ",
-            "wroten by [BSimjoo](https://github.com/bsimjoo) and this is a default message\\.\n",
+            "wrote by [BSimjoo](https://github.com/bsimjoo) and this is a default message\\.\n",
             "*Owner can edit this message in strings\\.json file*"
         ],
         "group-intro": [
             "Hi everybody, I'm open\\-source [telegram RSS bot](https://github.com/bsimjoo/Telegram_RSS_bot) ",
-            "wroten by [BSimjoo](https://github.com/bsimjoo) and this is a default message\\.\n",
+            "wrote by [BSimjoo](https://github.com/bsimjoo) and this is a default message\\.\n",
             "*Owner can edit this message in strings\\.json file*"
         ],
         "new-feed": "🆕♨️New post on weblog:",
@@ -28,12 +28,12 @@
             "/last_feed Get last post of weblog\n\n",
             "/help      Show this help"
         ],
-        "time-limit-error": "Sorry, I can not answer you right now because of time limition between two request, try again 2 mins later.",
+        "time-limit-error": "Sorry, I can not answer you right now because of time limitation between two request, try again 2 mins later.",
         "unknown": "Unknown command",
         "unknown-msg": "Sorry, I can't chat with anyone right now!"
     },
     "fa-ir": {
-        "wellcome": [
+        "welcome": [
             "سلام، من ربات متن باز ",
             "(Telegram RSS Bot)[https://github.com/bsimjoo/Telegram_RSS_bot] ",
             "هستم و توسط ",