From 16f46e4ecc87af48b6199de35c5688182d0ff3eb Mon Sep 17 00:00:00 2001 From: raisultan Date: Mon, 3 Jul 2023 15:02:53 +0600 Subject: [PATCH] =?UTF-8?q?update=20readme=20=F0=9F=93=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 549e8a2..b988da1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ +## NotionPM + +NotionPM (Notion Project Management) is a tool that helps teams using Notion for Project Management +and Telegram for communcation to be more effective and stay up-to-date with any changes related to +projects. + +It monitors given database for certain fields and sends near real time notifications to specific user or +to a group chat with team members, so that everyone can monitor and track changes and react quickly if needed. + +## Technical Side + +This repo implements features as: +- authorization +- setup: choosing database, fields and place to send notifications (dms or group chat) +- tracking of changes in database pages + +### Technologies Used +- aiohttp: as a web server +- rocketry: as a scheduler +- aiotg: as Telegram client +- notion-python: as Notion client +- poetry: as a dependency manager +- docker: as a containerization tool + ## Usefule links - [Accessing Notion API with Python](https://thienqc.notion.site/Notion-API-Python-ca0fd21bc224492b8daaf37eb06289e8) - [Notion API Guide JS](https://developers.notion.com/docs/getting-started) - [Notion API Raw Docs](https://developers.notion.com/reference) - [Notion Postman](https://www.postman.com/notionhq/workspace/notion-s-api-workspace/overview) - [Notion Python Client](https://github.com/ramnes/notion-sdk-py) - -## Local Redis -```shell - -# LOCAL run redis -docker run --name notionpm-redis -d -p 6379:6379 redis - -# access redis-cli -docker exec -it redis-cli -```