naitikraj3101 / botstatus

An action to automatically update bot status at GitHub as well as in Telegram channel.

BotStatus ~

A simple & short repository to show your bot's status in your GitHub README.md file as well as in you channel.

---

How to use this ?

• Star this repo. ⭐
• Go to the repository where you want to display the status of the bots. 🤖
• Go to environment variables (Settings ⇢ Secrets ⇢ New Repository Secret.) 🚶
• Fill all Environment variables there. 🤭
• Copy this snippet in ./github/workflows/main.yml in your repository. 📁
• The workflow will automatically run at interval of 3 hours. 🏃

⚠️ 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.

🤫 Environment variables

🔒 Secret 🔒	✍️ Description ✍️
API_HASH	Get it from my.telegram.org
APP_ID	Get it from my.telegram.org
CHANNEL_ID	Channel ID eg. -10010254xxxxx
MESSAGE_ID	Message ID of the message to edit.
SESSION
BOTS	Raw link of JSON file of bots. example

Optional variables ~

• FILE_NAME : Name of the MarkDown file, eg. README.md. This is case sensitive. Defaults to README.md.

✌️  Support me

     

💻 Credits

• xditya for inspiration from his repo.
• Lonami for telethon.
• Google and Telethon docs 😅

---

License

BotStatus is licensed under GNU Affero General Public License v3 or later.

The GNU General Public License (GNU GPL or simply GPL) is a series of widely-used free software licenses that guarantee end users the freedom to run, study, share, and modify the software.[8] The licenses were originally written by Richard Stallman, founder of the Free Software Foundation (FSF), for the GNU Project, and grant the recipients of a computer program the rights of the Free Software Definition.[9] The GPL series are all copyleft licenses, which means that any derivative work must be distributed under the same or equivalent license terms. This is in distinction to permissive software licenses, of which the BSD licenses and the MIT License are widely used, less restrictive examples. GPL was the first copyleft license for general use.