Skip to content

Latest commit

 

History

History
127 lines (93 loc) · 3.65 KB

README.md

File metadata and controls

127 lines (93 loc) · 3.65 KB
Raw

Afterwards (aw)

GitHub license GitHub repo size in bytes GitHub tag Build Status codecov GitHub last commit

Afterwards is a command-line task reminder utility for Linux, written primarily in Python (and utilizing Linux tools). The user specifies a date, a time and a message, and at the specified moment aw sounds an alarm and displays an alert window. That's loyalty for you.

Note that aw is meant to be used from the Run Command tool (usually accessed by pressing Alt-F2 on Gnome desktops), but you can certainly run it from the terminal as well.

Usage

$ aw <date> <time> <msg>

  • <date>:
    Supported formats:
        - numerical (MM/DD, MM-DD, MM.DD)
        - text (MONTH D), eg. "July 6" or "Jul 6"
        - "today", "tomorrow"

  • <time>:
    Supported formats:
        - 24-hour (HHMM)
        - 12-hour with AM/PM (HH:MM AM/PM)

  • <msg>:
    The actual text of the reminder.
    Case sensitive (duh!).

Dependencies

Note that so far Afterwards has been tested on Ubuntu 18.04 only. If you're on it too, you would install these things by typing something like this into your shell:

$ sudo apt install sox libsox-fmt-mp3 zenity at

  • Python:
      Surprised? Let me explain. The entire thing is written in it.
      Versions 3.5+ should work.

  • SoX:
      Sound eXchange, the Swiss Army knife of audio manipulation
      (that's from the man page, but I only use it to play music).

  • libsox-fmt-mp3:
      An MP3 handler library for SoX.

  • Zenity:
      GTK+ dialog box maker.

  • at:
      Non-recurring, one-time task scheduler (among other things).

Installation

$ # Clone it from GitHub
$ git clone https://github.com/trk9001/afterwards.git
$ cd afterwards
$ # Make the setup script executable
$ chmod +x install.sh
$ ./install.sh

On the other hand, uninstalling is totally ez:

$ aw --uninstall

Testing

Use pytest.

The future

Can't see it.

The tentative future

I was thinking of these at points:

  • Easier user customization, and more of it.
  • Multiple reminders for the same task. Or at least two.

To contribute or not to contribute

If you're using aw, I would really appreciate your feedback and/or criticism. And if you find it useful, please Star it!

Please check the issues out, and if you can help out with any, kindly make a pull request. You are also most welcome to open an issue to report a bug or ask a q or just to chat :)

License

Copyright © 2018 trk9001

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

And btw

This was made for my best friend, Shahidi.