https://github.com/raghur/hey.py

Dead simple reminder CLI tool for linux; Reminders are shown on Web and Mobile using your own Telegram bot
https://github.com/raghur/hey.py

atd console-tool linux-app productivity-timer reminder-app telegram-bot

Last synced: about 1 month ago
JSON representation

Dead simple reminder CLI tool for linux; Reminders are shown on Web and Mobile using your own Telegram bot

• Host: GitHub
• URL: https://github.com/raghur/hey.py
• Owner: raghur
• Created: 2019-09-08T07:41:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T21:46:13.000Z (11 months ago)
• Last Synced: 2025-04-30T21:54:51.282Z (about 1 month ago)
• Topics: atd, console-tool, linux-app, productivity-timer, reminder-app, telegram-bot
• Language: Python
• Homepage:
• Size: 56.6 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
## Hey - your personal telegram notifier

Set simple one-shot reminders and texts with an easy, approachable CLI with notifications on all your devices

### Why

. Dead simple - all of 130 lines in a single script file

. No server process to run. Uses `atd` daemon and most likely that's already running

. Telegram clients are available for pretty much every platform

. Handles fuzzy, human friendly dates and times (like `friday after next`); Handles timezone conversions as well (so `9AM EST`)

But my machine isn't ONLINE 24x7::

. Install it on a server and with password-less ssh and setup a shell script or alias to execute `hey` on the server.

### Installation

[source,shell]

----

# clone the repo

# cd into the folder

./install.sh

# check if at daemon is enabled & running

sudo systemctl status atd

# Enable and start it if needed.

sudo systemctl enable atd

sudo systemctl start atd

----

That's about it for installation

You'll need to configure a telegram bot 

before you can get started. See the section below

### Configuration

Create a telegram BOT::

. Create a telegram bot and send it a message

    * search for BotFather

    * type `/newbot`

    * give it a friendly name and a bot name (bot name must end in _bot)

    * Pick up the bot token from botfather.

. Get a chat id

    * Telegram global search, type your bot name or id

    * type `/start`

    * send any text.

    * Run `curl https://api.telegram.org/bot$TOKEN/getUpdates`

+

[source,shell]

----

    {

  "ok": true,

  "result": [

    {

      "update_id": 519260759,

      "message": {

        "message_id": 2,

        "from": {

          "id": 535955002,

          "is_bot": false,

        },

        "chat": {

          "id": 123456789, //<1> 

          "type": "private"

        },

        "date": 1567922393,

        "text": "hello"

      }

    }

  ]

}

----

. Update the `config` file in the folder with the bot token and chat id

### Timezone

In case you run this on a server that's on UTC (As with most cloud providers),

then set the `TIMEZONE=` to set the timezone of the _client_ machine.

*NOTE* Once again,  this isn't the server timezone.  If your client and server

are in the same timezone, then DO NOT specify the timezone (key should not

present)

*NOTE 2*: Timezone code is one of TZ database names, like so - `TIMEZONE=Asia/Kolkata`

see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[TZ Database]

### Config file locations

Files are read in the following sequence, later files override earlier entries defined in earlier ones.

. Alongside `hey.py`, named as `config`

. `/etc/hey.conf`

. `~/.config/hey.conf`

### Usage

[source,shell]

----

> hey.py /t 10 AM Friday /m Get a hair cut

# My local timezone is India (IST, +0530), hey is on a server on UTC

# and you can have tz info in the string - say some office opens at 9 AM EST

> hey.py -t 9 AM EST -m call customer support

reminder 'call customer support' set for 10:30 PM 2019-10-16

----

NOTE: arg parsing is basic and does not follow typical shell parsing conventions. 

First arg has to be `/t` and then it scans forward till a `/m`. The gathered string is 

parsed to a date. Anything after the /m is just concatenated to the message.

## Time expressions

[source,shell]

----

Time expression examples:

    in 10 minutes

    in 1 month

    next week

    friday 10 AM

    wed 10 AM

    10 AM Tues

Refer to https://dateparser.readthedocs.io/en/latest/ for documentation on date

expressions

----