Giter Club home page Giter Club logo

skarmabot's Introduction

SKarma

Yet another karma bot for telegram groups.

Access bot

Bot is accessible on @skarmabot

Download latest version

You can download SKarma 0.1.1 source here

Features

  • Karma :)
  • Karma levels, each have own name and rights
  • Announcements system
  • Get top of your chat's users
  • Russian language
  • Logging
  • Error managment system

Contribution

You can freely contribute to our github. There're many things you can do: fix bugs, add new features, make translations. Please follow several simple rules:

  • DO NOT commit to master, use develop or create your own branch instead
  • Create one issue per one bug
  • Do not duplicate issues
  • Specify steps to reproduce in issues
  • Create one pull request per one feature
  • Create one commit for one small piece of implementation
  • Write simple functions. Every function must do one small thing. All actions in function must be on one abstraction level
  • Use python's typing module. Specify type of return value and arguments, e.g.
def check(site: dict) -> bool:
    """Check if site is available."""
    
    pass
  • Write pydocs if it's needed
  • Write unit tests for your code (python unittest) and put it in "tests" folder
  • Place copyright and licence header in top of every file, you can find example in any project source file
  • Before starting pull request, run all unit tests to make sure that you did not break anything
  • Add your name to list of contributors in end of this file

License

GNU AGPL v3 logo

SKarma is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License.

SKarma is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with SKarma. If not, see https://www.gnu.org/licenses/.

Links

Authors and copyright

Copyright (C) 2020 Nikita Serba. All Rights Reserved.
For any questions contact [email protected]
Project team:

Special thanks to Kirill Velichko (t.me/kladbm), Dmytro Pohodaiev and "Corpse of Flying Crucian-Pyromancer under Metaqualon" for helping me in testing bot.

Contributors:

skarmabot's People

Contributors

sandsbit avatar

Watchers

 avatar

Forkers

raknaroy

skarmabot's Issues

Announcements sending duplication

Announcements could be sent but not deleted from the database in case of bot crash while sending them. In that case, the bot will resend it after the restart. This leads to announcement duplication.

The bot could crash between sending data to different chats, but the database doesn't store information about which chats should receive them, so it couldn't be fixed quickly.

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.