A Telegram Python bot running on python3 forked with saitama with a sqlalchemy database and an entirely themed persona to make chizuru fun and good management for you in your groups.
Can be found on telegram as Mizuhara robot.
The Support group can be reached out to at chizuru support, where you can ask for help , discover new features, report bugs, and stay in the loop whenever a new update is available.
News channel as at Chizuru updates
Fill in all the details, Deploy! Now go to https://dashboard.heroku.com/apps/(app-name)/resources ( Replace (app-name) with your app name ) REMEMBER: Turn on worker dyno (Don't worry It's free :D) & Webhook Now send the bot /start, If it doesn't respond go to https://dashboard.heroku.com/apps/(app-name)/settings and remove webhook and port.
Please make sure to use python3.6, as I cannot guarantee everything will work as expected on older Python versions! This is because markdown parsing is done by iterating through a dict, which is ordered by default in 3.6.
There are two possible ways of configuring your bot: a config.py file, or ENV variables.
The preferred version is to use a
config.py file, as it makes it easier to see all your settings grouped together.
This file should be placed in your
Mizuhararobot folder, alongside the
This is where your bot token will be loaded from, as well as your database URI (if you're using a database), and most of
your other settings.
It is recommended to import sample_config and extend the Config class, as this will ensure your config contains all defaults set in the sample_config, hence making it easier to upgrade.
config.py file could be:
from Mizuhararobot.sample_config import Config class Development(Config): OWNER_ID = 254318997 # your telegram ID OWNER_USERNAME = "SonOfLars" # your telegram username API_KEY = "your bot api key" # your api key, as provided by the @botfather SQLALCHEMY_DATABASE_URI = 'postgresql://username:password@localhost:5432/database' # sample db credentials JOIN_LOGGER = '-1234567890' # some group chat that your bot is a member of USE_JOIN_LOGGER = True DRAGONS = [18673980, 83489514] # List of id's for users which have sudo access to the bot. LOAD =  NO_LOAD = ['translation']
If you can't have a config.py file (EG on Heroku), it is also possible to use environment variables. So just go and read the config sample file.
Install the necessary Python dependencies by moving to the project directory and running:
pip3 install -r requirements.txt.
This will install all the necessary python packages.
If you wish to use a database-dependent module (eg: locks, notes, userinfo, users, filters, welcomes), you'll need to have a database installed on your system. I use Postgres, so I recommend using it for optimal compatibility.
In the case of Postgres, this is how you would set up a database on a Debian/ubuntu system. Other distributions may vary.
sudo apt-get update && sudo apt-get install postgresql
sudo su - postgres
createuser -P -s -e YOUR_USER
This will be followed by you need to input your password.
createdb -O YOUR_USER YOUR_DB_NAME
Change YOUR_USER and YOUR_DB_NAME appropriately.
psql YOUR_DB_NAME -h YOUR_HOST YOUR_USER
This will allow you to connect to your database via your terminal. By default, YOUR_HOST should be 0.0.0.0:5432.
You should now be able to build your database URI. This will be:
Replace sqldbtype with whichever DB you're using (eg Postgres, MySQL, SQLite, etc) repeat for your username, password, hostname (localhost?), port (5432?), and DB name.
The module load order can be changed via the
NO_LOAD configuration settings.
These should both represent lists.
LOAD is an empty list, all modules in
modules/ will be selected for loading by default.
NO_LOAD is not present or is an empty list, all modules selected for loading will be loaded.
If a module is in both
NO_LOAD, the module will not be loaded -
NO_LOAD takes priority.
Creating a module has been simplified as much as possible - but do not hesitate to suggest further simplification.
All that is needed is that your .py file is in the modules folder.
To add commands, make sure to import the dispatcher via
from Mizuhararobot import dispatcher.
You can then add commands using the usual
__help__ variable to a string describing this modules' available
commands will allow the bot to load it and add the documentation for
your module to the
/help command. Setting the
__mod_name__ variable will also allow you to use a nicer, user-friendly name for a module.
__migrate__() function is used for migrating chats - when a chat is upgraded to a supergroup, the ID changes, so
it is necessary to migrate it in the DB.
__stats__() function is for retrieving module statistics, eg number of users, number of chats. This is accessed
/stats command, which is only available to the bot owner.
Once you've set up your database and your configuration is complete, simply run the bat file(if on windows) or run (Linux):
python3 -m Mizuhararobot
You can use nssm to install the bot as service on windows and set it to restart on /gitpull Make sure to edit the start and restart bats to your needs. Note: the restart bat requires that User account control be disabled.
For queries or any issues regarding the bot please open an issue ticket or visit us at Mizuhara Support
The bot is based on the original work done by PaulSonOfLars This repo was just revamped to suit an Anime-centric community. All original credits go to Paul and his dedication, Without his efforts, this fork would not have been possible!
Also, missing proper credit for blacklistusers taken from TheRealPhoenixBot (will add it later, this note says unless it is done)
Any other authorship/credits can be seen through the commits.
Should any be missing kindly let us know at Mizuhara Support or simply submit a pull request on the readme.