A Telegram Python bot running on python3 forked with saitama and DiasyX with a sqlalchemy database and an entirely themed persona to make Kazuko fun and good management for you in your groups.
Can be found on telegram as KazukoBot.
The Support group can be reached out to at Kazuko 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 Kazuko Updates
- This bot is forked from yone and saitama (which is based on marie)
- Your code must be open source and a link to our repo
- Fork and deploy on your own risk...
Steps to deploy on Heroku !!
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.
Steps to self Host!!
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 KazukoBot
folder, alongside the __main__.py
file.
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.
An example config.py
file could be:
from KazukoBot.sample_config import Config
class Development(Config):
OWNER_ID = 1821151467 # your telegram ID
OWNER_USERNAME = "heyaaman" # 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.
The easiest way to deploy this Bot is via Heroku.
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.
- install postgresql:
sudo apt-get update && sudo apt-get install postgresql
- change to the Postgres user:
sudo su - postgres
- create a new database user (change YOUR_USER appropriately):
createuser -P -s -e YOUR_USER
This will be followed by you need to input your password.
- create a new database table:
createdb -O YOUR_USER YOUR_DB_NAME
Change YOUR_USER and YOUR_DB_NAME appropriately.
- finally:
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:
sqldbtype://username:pw@hostname:port/db_name
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 LOAD
and NO_LOAD
configuration settings.
These should both represent lists.
If LOAD
is an empty list, all modules in modules/
will be selected for loading by default.
If NO_LOAD
is not present or is an empty list, all modules selected for loading will be loaded.
If a module is in both LOAD
and 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 KazukoBot import dispatcher
.
You can then add commands using the usual
dispatcher.add_handler()
.
Assigning the __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.
The __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.
The __stats__()
function is for retrieving module statistics, eg number of users, number of chats. This is accessed
through the /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 KazukoBot
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 CFC BOT SUPPORT
CREDITS
❤️ Saitama = Sawada
❤️ DaisyX = Inuka
❤️ Yone = Noob kittu
❤️ William Butcher Bot = TheHamkerCat
This Bot Is Developed By heyaaman