Git Product home page Git Product logo

metabutler's Introduction

MetaButler

A modular telegram Python bot running on python3 with an sqlalchemy database.

Originally a Kigyo fork -

Can be found on telegram as MetaButler.

The Support group can be reached out to at MetaButler, where you can ask for help setting up your bot, discover/request new features, report bugs, and stay in the loop whenever a new update is available.

Setting up the bot (Read this before trying to use!):

How to setup

  • clone this repository
  • cd MetaButler
  • cp sample_config.ini config.ini
  • Fill in all the vars
  • pip3 install -U -r requirements.txt
  • And finally python3 -m MetaButler

Enjoy!

How can I obtain bot_token?

Just talk to BotFather(described here) and follow a few simple steps. Once you've created a bot and received your authorization token, that's it! that's your bot_token.

How can I obtain a api_key and api_hash?

In order to obtain an API key and hash you need to do the following:

  • Sign up for Telegram using any application.
  • Login to your Telegram core: https://my.telegram.org.
  • Go to 'API Development tools' and fill out the form.
  • You will get basic addresses as well as the api_id and api_hash parameters required for Metabutler's configuration file.

Database

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 the 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 needing 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 youre using(eg postgres, mysql, sqllite, etc) repeat for your username, password, hostname(localhost?), port(5432?), and db name.

Credits

The bot is based of on the original work done by

Thanks to

metabutler's People

Contributors

1maverick1 avatar anirudhgupta109 avatar architdate avatar ayrahikari avatar dank-del avatar deepsource-autofix[bot] avatar deepsourcebot avatar destroyer-32 avatar dragsama avatar fushinori avatar gotenksin avatar halodragon7410 avatar jvlianodorneles avatar neppu-nep avatar notfounderror avatar omar-abdul-azeez avatar paulsonoflars avatar rohk25 avatar sitischu avatar skittles9823 avatar soapdev2018 avatar spechide avatar sphericalkat avatar starry-shivam avatar termozour avatar the-blank-x avatar tomyprs avatar tsunayoshisawada avatar tusharsadhwani avatar yasir-siddiqui avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.