EN

RU

NotesAssistant

Bot for organizing notes in Telegram

Storing, adding, editing and deleting notes by date. You can tag a note with an emoji. Convenient search by emoji statuses and dates. Birthdays and holidays are marked on the calendar (you need to set an emoji status).

Installation instructions

Download

git clone https://github.com/EgorKhabarov/NotesAssistant
cd NotesAssistant
cp config.example.yaml config.yaml
pip install -r requirements.txt

Settings

Edit config.yaml in the bot directory

BOT_TOKEN: ""        # Telegram bot token from https://t.me/BotFather
WEATHER_API_KEY: ""  # Get it from https://home.openweathermap.org/api_keys

Set up a bot at https://t.me/BotFather

/mybots -> @your_bot_username

Bot Settings -> Group Privacy -> disabled
Bot Settings -> Inline Mode   -> disabled

Launch

Only bot

python start_bot.py

Server

python -c "from server import app;app.run('0.0.0.0')"

Getting administrator rights

Get your telegram chat_id

Launch the bot and send the command /id. Add the resulting chat_id to ADMIN_IDS in config.yaml and restart the bot.

Important

Add only chat_id of personal accounts (private chats)! Any interaction of any person in a telegram group with a bot is perceived as on behalf of the group.

Setting up PythonAnywhere

• Create a web server using the latest available version of Python
• In the Code category change Working directory to the path to the folder with server.py
• In the Security category change Force HTTPS to Enabled

Docker

docker build -t NotesAssistant .
docker volume create NotesAssistantData
docker volume create NotesAssistantLogs
docker run -p 5000:5000 -v NotesAssistantData:/app/data -v NotesAssistantLogs:/app/logs --name NotesAssistantContainer NotesAssistant -d NotesAssistant

docker compose up -d --build

---

Commands

• /start
• /menu
  • /help
  • /calendar
  • account
  • groups
  • /week_event_list
  • notifications
  • /settings
  • trash
• /calendar
• /today
• /week_event_list
• /export

start

Greets the user.

Buttons	Actions
/menu	Same as /menu command
/calendar	Same as /calendar command

menu

Navigation through bot functions.

Buttons	Actions
📚 Help	Same as /help
📆 Calendar	Same as /calendar
👤 Account	Personal account and data export
👥 Groups	Group settings
📆 7 days	Notes in the next 7 days
🔔 Notifications	View notes that will be included in the notification
⚙ Settings	Same as /settings
🗑 Bin	Recycle bin with deleted notes (premium)

help

Gives access to information about the bot's capabilities.

calendar

Calendar.

January (1.2000) (Leap 🐲) (52-5)
Mo	Tu!	We	Th	Fr	Sa	Su
						2
3		5		7	8	9
10!	11	12	13	14	15	16
17	18	19	20	21	22	23
24	25	26	27	28	29	30
31
<<		<	⟳	>	>>
🔙				🗂

Designations

First button

When pressed, a yearly calendar appears.

Designation	Meaning
January	Names of the month
(1.2000)	Month and year numbers
(Leap 🐲)	Is it a leap year and the animal of this year
(52-5)	Numbers of the first and last week

Days of the week

When pressed, they do nothing. The text on the button may end with the ! character. This means that on this day of the week there are repeating notes with an interval of a week (more about statuses).

Button for the day

When pressed, it calls up message for one day

Sign	Designation
#	Today
*	There are notes on this day If there are less than 10 notes then it will consist of degree icons indicating the number of notes
!	There is an important note on this day For example, with the status birthday 🎉 or holiday 🎊

Navigation buttons

Buttons	Actions
<<	Show calendar for one year ago
<	Show calendar for one month ago
⟳	Show calendar for current date
>	Show calendar one month ahead
>>	Show calendar for one year ahead

Tip

When you click on a ⟳ in the calendar, today's date opens.

Colors

Color	Designation
	Today
	There are notes on this day

account

Here you can change your username and password or log out of your account. You can also view your limits 📊.

groups

You can connect a group to your account in the bot.

🔸All	Member	Moderator	Admin
<Your first group name>
🔙		👥 Create group

week_event_list

Message with notes in the next 7 days.

notifications

Message with notes for today, tomorrow, after tomorrow, after after tomorrow and in a week.

settings

Message with settings.

🗣 ru	🔗 True	⬆️	🔕	⬛️
-3	-1	3 🌍	+1	+3
-1h	-10m	08:00 ⏰	+10m	+1h
Default settings

Sign	Designation
🗣	Language (default ru)
🔗	Should I shorten links (https://en.wikipedia.org/wiki/Hyperlink → en.wikipedia.org)
⬇️ / ⬆️	Note sort order
🔕	Whether to enable notifications (disabled by default)
⬜️ / ⬛️	Bot theme (replaces dark emoticons with light ones)
🌍	Your time zone
⏰	Notification Time

trash

List of deleted notes.

🔼 Select one note	↕️ Select multiple notes
🧹 Empty Trash	🔄 Update cart

today

➕	🔼	↕️	Menu
🔙	<	>	🔄

Sign	Designation
➕	Add note
🔼	Select one note
↕️	Select multiple notes
Menu	Return to menu
🔙	Return to calendar
<	Show message for yesterday
>	Show message for tomorrow
🔄	Update message

export

Export notes in different file formats csv, xml, json, jsonl.

Message for one note

📝Edit text	🏷Statuses	🗑Delete note
📋Display		📅Change date
ℹ️Information	🗄Сhange history
🔙Back		🔄Update message

Note statuses

A status is one or more emoji to mark an note or add different effects.

Note can have a maximum of 5 statuses.

Important

There are incompatible statuses.

They cannot be placed together in the same note.

If you have one note from a pair, then you will not be able to place the second one.

Incompatible statuses
🔗 (Link) and 💻 (Code)
🪞 (Hidden) and 💻 (Code)
🔗 (Link) and ⛓ (No link shortening)
🧮 (Numbered List) and 🗒 (List)

Status effects are used only to visually display events. The event text itself remains unchanged.

Limits

There are limits for different user groups.

Maximum possible values

user_status	note day	symbol day	note month	symbol month	note year	symbol year	note all	symbol all
default	20	4000	75	10000	500	80000	500	100000
premium	40	8000	100	15000	750	100000	900	150000
admin	60	20000	200	65000	1000	120000	2000	200000

Search

The bot features a convenient search feature for notes. You can search using a message beginning with # (e.g., #query) or the command /search query. This search attempts to find all matches. The query #1 2 finds all notes containing the numbers 1 OR 2 (t1ext, tex2t, 2te1xt).

open

Daily message
/open_today[_page_<page>]
/open_now[_page_<page>]

Monthly/Yearly calendar message
/open_calendar
/open_calendar_year

Open
/open[_<year>[_<month>[_<day>[_page_<page>]]]]