📝 Minor changes.

Author: jainamoswal

Diff for: ReadMe.md

@@ -6,7 +6,6 @@
 [![Contributors](https://img.shields.io/github/contributors/jainamoswal/BotStatus?style=for-the-badge&color=green)](https://github.com/jainamoswal/BotStatus)
 
 
-
 ## BotStatus ~ 
 
 A simple & short repository to show your bot's status in your GitHub README.md file as well as in you channel. 
@@ -24,18 +23,22 @@ A simple & short repository to show your bot's status in your GitHub README.md f
 _⚠️ You'll need a bots.json file and list all bots in the JSON format.
 It can be raw link from `gist.github.com` or directly by the file itself like `https://github.com/<blabla>/raw/<branchname>/<filename>`. But it should point to the raw source._ 
 
+
 <details>
   <summary><b>🤫&nbsp;Environment variables</b></summary>
   <br/>
 
 | 🔒 Secret 🔒 | ✍️ Description ✍️ |
 | :-: | :-: |
-| API_HASH | Get it from [my.telegram.org](https://my.telegram.org) |
-| APP_ID | Get it from [my.telegram.org](https://my.telegram.org) |
-| CHANNEL_ID | Channel ID eg. -10010254xxxxx |
-| MESSAGE_ID | Message ID of the message to edit. |
-| SESSION | [![Run on Repl.it](https://replit.com/badge/github/jainamoswal/SessionString)](https://replit.com/@jainamoswal/SessionString) |
-| BOTS | Raw link of JSON file of bots. [example](./example.json) |
+| `API_HASH` | Get it from [my.telegram.org](https://my.telegram.org) |
+| `APP_ID` | Get it from [my.telegram.org](https://my.telegram.org) |
+| `CHANNEL_ID` | Channel ID eg. -10010254xxxxx |
+| `MESSAGE_ID` | Message ID of the message to edit. |
+| `SESSION` | [![Run on Repl.it](https://replit.com/badge/github/jainamoswal/SessionString)](https://replit.com/@jainamoswal/SessionString) |
+| `BOTS` | Raw link of JSON file of bots. [example](./example.json) |
+  
+<b>Optional variables ~ </b>
+- `FILE_NAME` : Name of the MarkDown file, eg. `README.md`. This is case sensitive. Defaults to `README.md`.
 </details>
 
 

Diff for: main.py

@@ -18,6 +18,7 @@
 api_hash = os.getenv('API_HASH') # APP hash from my.telegram.org
 session = os.getenv('SESSION') # session string via telethon
 client = telethon.TelegramClient(telethon.sessions.StringSession(session), api_id, api_hash) # none of your bussiness 
+file_name = 'README.md' if os.getenv('FILE_NAME') is None else os.getenv('FILE_NAME')  # filename is case sensitive
 
 # print some information
 def display():
@@ -32,51 +33,51 @@ def display():
 def updateme(old, json_data, first_match, second_match):
     new = '''\n| 🤖 Bot 🤖 | ⭐️ Status ⭐️ |\n| :-: | :-: |\n'''
     for i in json_data:
-        new += f"| [{i}](https://t.me/{i}) | {'✔️' if json_data[i] else '❌'} |\n"
+        new += f"| [{json_data[i]['name']}](https://t.me/{i}) | {'✔️' if json_data[i]['status'] else '❌'} |\n"
     new_string = f"\n{first_match}\n{new}\n`Updated last at ~ {datetime.now(timezone('Asia/Kolkata')).strftime('%H:%M:%S on %Y-%m-%d ')} INR` 🏳️‍🌈\n\n"
     new_string += f"**Made with ❤️ via [BotStatus](https://github.com/jainamoswal/botstatus)**. \n{second_match}"
     return re.sub(f'\n{first_match}.*?{second_match}', new_string, old, flags=re.DOTALL)
 
 # fetch status of all bots listed in the raw gist file
 async def main():
+    bot_status = {}
     async with client:
-        bot_status = {}
         for each_bot in bots:
             async with client.conversation(each_bot, exclusive=False) as conv:
+                name = await client.get_entity(each_bot)
                 try:
                     sent = await conv.send_message('/' + bots[each_bot]['start'])
                     received = await conv.get_response(timeout=bots[each_bot]['sleep'])
                     await received.delete()
-                    bot_status.update({each_bot:True})
+                    bot_status.update({each_bot:{'name':name.first_name, 'status':True}})
                     await sent.delete()
                 except Exception as e:
                     if type(e).__name__ == "YouBlockedUserError":
                         print(f'🚧 You\'ve blocked @{each_bot}. Please unblock it, until next run, I\'ll mark it as down. 🚧') # you blocked the bot :(
-                    bot_status.update({each_bot:False}) # bot didn't replied back :(      
+                    bot_status.update({each_bot:{'name':name.first_name, 'status':False}}) # bot didn't replied back :(      
         return bot_status
 
 # edit the message with status at telegram
 async def edit_message(data):
     async with client:
         text = 'Live status of my bots goes following ~\n'
         for i in data:
-            text += f"🔅 [{i}](https://t.me/{i}) ~ {'🚀' if data[i] else '❌'}\n"
+            text += f"🔅 [{data[i]['name']}](https://t.me/{i}) ~ {'🚀' if data[i]['status'] else '❌'}\n"
         text += f"\n**Last Checked:** \n__{datetime.now(timezone('Asia/Kolkata')).strftime('%Y-%m-%d %H:%M:%S')} IST__\n\n**Bots status are auto-updated every 3 hours at random frequency.**\n\n[J Projects](https://t.me/J_Projects)"
         await client.edit_message(int(os.getenv('CHANNEL_ID')), int(os.getenv('MESSAGE_ID')), text, link_preview=False)
 
 # run the script via __main__ style
 if __name__ == '__main__':
     json_data = client.loop.run_until_complete(main())
     display() 
+    print(json_data)
     for each in json_data:
-      print(f"🔸 @{each} is {'🟢' if json_data[each] else '🔴'}")
+        print(f"🔸 {json_data[each]['name']} [@{each}] is {'🟢' if json_data[each]['status'] else '🔴'}")
     client.loop.run_until_complete(edit_message(json_data))
     repo = github.Github(os.getenv('GITHUB_TOKEN')).get_repo(os.getenv('GITHUB_REPOSITORY'))
-    contents = repo.get_contents("README.md")
-    repo.update_file("README.md", "✨ auto-updated bot status. ✨", updateme(contents.decoded_content.decode(), json_data, '<start>', '<end>'), contents.sha)
+    contents = repo.get_contents(file_name) 
+    repo.update_file(file_name, "✨ auto-updated bot status. ✨", updateme(contents.decoded_content.decode(), json_data, '<start>', '<end>'), contents.sha)
 
 print()
 print('::::::::::::::::::::: 🎉 Action completed successfully 🎉 :::::::::::::::::::::')
-print('Mind joining @j_projects at Telegram and do follow me on github.com <jainamoswal>')
-
-
+print('Mind joining @j_projects at Telegram and do follow me on github.com <jainamoswal>')