https://github.com/macket/inspector_habit_tamtam
Inspector Habit helps people to develop good habits and break bad ones. Users can also plan their day and create reminders via voice messages.
https://github.com/macket/inspector_habit_tamtam
python tamtambot
Last synced: about 2 months ago
JSON representation
Inspector Habit helps people to develop good habits and break bad ones. Users can also plan their day and create reminders via voice messages.
- Host: GitHub
- URL: https://github.com/macket/inspector_habit_tamtam
- Owner: Macket
- Created: 2019-10-24T19:30:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-22T23:30:34.000Z (about 4 years ago)
- Last Synced: 2025-01-09T08:46:41.942Z (over 1 year ago)
- Topics: python, tamtambot
- Language: Python
- Homepage: https://tt.me/inspector_habit
- Size: 612 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Inspector Habit — 🏆 [The Winner](https://tamtam.chat/botapichannel/AW5LroptDXs) of TamTam [bot developers contest](https://blog.tamtam.chat/ru/2019/08/02/)
Inspector Habit is a [TamTam](https://tamtam.chat/) bot which helps people to develop good habits and break bad ones. Users can also plan their day and create reminders via voice messages.
## Getting Started
Inspector Habit bot requires Python 3.7 and packages specified in ```requirements.txt```.
You can install them with
```
pip install -r requirements.txt
```
Before you start Inspector Habit it is necessary to create ```.env``` file:
```
touch .env
```
and fill in this file according to the example below:
```
DEBUG = True
TT_BOT_API_TOKEN = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
ADMIN_ID = XXXXXXXXXXX
DATABASE_URL = postgres://XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
DB_NAME = inspector_habit_db
DB_USER = user
DB_PASSWORD = XXXXXXXXXXX
DB_HOST = localhost
```
```DEBUG``` should be **False** in prod
```TT_BOT_API_TOKEN``` is the token got from [PrimeBot](https://tt.me/primebot)
```ADMIN_ID``` is the TamTam id of the admin
```DATABASE_URL``` is used to access the database in prod
```DB_NAME```, ```DB_USER```, ```DB_PASSWORD``` and ```DB_HOST``` are used to access the database in dev
Then you can start Inspector Habit with this command:
```
python main.py
```
## Use case
There are three main functions in the menu: **🗓 Habits**, **📝 Plans** and **🔔 Reminders**.
### 🗓 Habits
Let's see current active habits.
And let's create a new one.
When check time is coming, we will get the following message from Inspector Habit.
Suppose we kept our promise and tap **✅ Yes**.
### 📝 Plans
Let's create today plan.
Ok, plan is ready.
Now we can report.
Suppose that we have done README.
When report is ended we will see the following.
And can create tomorrow plan.
### **🔔 Reminders**
How to create reminders?
Ok, we don't have any reminders, so let's create the first one.
And we get a reminder in time.
