Code Monkey home page Code Monkey logo

stella's Introduction

Stella // @MissStella_bot

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

Codacy Badge Open Source Love
GPLv3 license

GitHub forks GitHub stars

stella

Originally a simple group management bot with multiple admin features, it has evolved, becoming extremely modular and simple to use. Can be found on telegram as Stella

Setting up the stella

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 are ordered by default in 3.6.

Configuration

Remove this line first before doing anything else

___________PLOX_______REMOVE_____THIS_____LINE__________=True

Required

  • API_KEY: Your bot token.

  • DEV_USERS: List of id's - (not usernames) for developers who will have the same perms as the owner

  • OWNER_ID: Bot owner id if you dont know, run the bot and do /id in your private chat with it.

  • OWNER_USERNAME: Bot owner username. eg.meanii

  • SQLALCHEMY_DATABASE_URI: Needed for any database modules eg. postgres://meanii:[email protected]:5432/meaniidb

  • MESSAGE_DUMP: Needed to make sure 'save from' messages persist.

  • GBAN_LOGS: Needed for /gban users logs.

  • SUDO_USERS: List of id's - (not usernames) for users. eg. [604968079, 802002142]

  • SUPPORT_USERS: List of id's (not usernames) for users which are allowed to gban, but can also be banned.

  • WHITELIST_USERS: List of id's (not usernames) for users which WONT be banned/kicked by the bot.

  • DEL_CMDS: Whether or not you should delete "blue text must click" commands.

Python dependencies

Install the necessary python dependencies by moving to the project directory and running:

pip3 install -r requirements.txt.

This will install all necessary python packages.

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:

@SonOfLars (Marie's creator)

@SaitamaRobot (for anime module)

@corsicanu (for welcome module)

@MrYacha (for Feds module)

stella's People

Contributors

meanii avatar namithesh avatar tsunayoshisawada avatar spookyneel 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.