Git Product home page Git Product logo

robo-notify's Introduction

Robo-notify

Simple robot to perform repetitive notifications using dunst. It is useful for tasks such as reminders or learning language vocabulary by doing the task of memorizing this content quickly through the aforementioned repetitions. (still in the process of improvement).

Requirements

  • dunst
  • python3+
  • libnotify-bin (in ubuntu and based distros "notify-osd")

Usage

  1. clone repo
git clone https://github.com/Yagua/robo-notify
  1. execute main script
cd robo-notify/
python3 main.py

# Recommended to make an alias with this instruction for example 'robonotify'

# in .bashrc
alias robonotify="python3 path_robo-notify/main.py"

Options

Option Description
-h, --help show this help message and exit
-t TIMER, --timer TIMER time in seconds for displaying notifications (default 600s [10 min])
-nt NOTIFICATIONTIME --notifitm NOTIFICATIONTIME time in seconds for the duration of popup notification)
-cp CUSTOMPATH, --custompath CUSTOMPATH print list from a custom filepath
-fn FILENAME, --filename FILENAME file name saved in list directory

Note

By default the robot has a couple of test content lists to initialize it. It is also possible to put more lists (json files) inside the "lists" directory of the project and initialize them with the robot by considering the file name, or simply passing an absolute path of a file to reprocess it.

Example of use

# considering that I put a file called 'w_sentences' in the robot's home directory
# -t 1 second time for repetitions
# -nt time of 2 seconds duration of popup notifications

robonotify -fn days -t 1 -nt 2

Preview

prev

robo-notify's People

Contributors

yagua avatar

Watchers

 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.