Giter VIP home page Giter VIP logo

eznotesbot's Introduction

EZ Notes Bot (ezNotesBot)

Telegram Bot for saving and sharing personal and group notes.

Usage

Personal notes:

  • reply to any message in PM to save it as a new note
  • search in inline mode for sharing notes
  • search - (hyphen-minus) for managing notes

Group notes:

  • add @ezNotesBot to your groups to use it
  • only anonymous admin can add/remove notes
  • +#hashtag [description] (as a reply) to add/replace a note
  • -#hashtag remove a note
  • /notes list notes
  • #hashtag show a note

Setup

This bot uses MariaDB for saving notes

Requirements

  • Python 3.8 or higher
  • A Telegram API key
  • A Telegram Bot created with BotFather with "inline mode" and "inline feedback" enabled (for personal notes) and "group privacy mode" disabled (for group notes)
  • libmariadbclient

Mariadb:

Shell

sudo mysql_install_db --user=mysql --basedir=/usr --datadir=/var/lib/mysql
# start MariaDB service

SQL

-- sudo mysql -u root
DROP USER IF EXISTS eznotes;
DROP DATABASE IF EXISTS eznotes;
CREATE DATABASE eznotes;
GRANT CREATE,DELETE,INSERT,SELECT,UPDATE ON eznotes.* TO `eznotes`@`localhost` IDENTIFIED BY 'password';
FLUSH PRIVILEGES;

Run the Bot

Create a new config.ini, copy-paste the following and replace the values with your own

[pyrogram]
api_id = 1234567
api_hash = 0123456789abcdef0123456789abcdef
bot_token = 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11

Run it

virtualenv venv
venv/bin/pip install -U -r requirements.txt
export MARIADB_HOST="localhost"
export MARIADB_PORT="3306"
export MARIADB_PASSWORD="password"
venv/bin/python bot.py

License

AGPL-3.0-or-later

ezNotesBot, Telegram Bot for saving and sharing personal and group notes
Copyright (C) 2021  Dash Eclipse

This program 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, or
(at your option) any later version.

This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.

eznotesbot's People

Contributors

dashezup 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.