https://github.com/s3rius/alarmix

Alarm clock based on Unix-sockets and python.
https://github.com/s3rius/alarmix

alarm alarmclock python3 sockets unix utility

Last synced: 25 days ago
JSON representation

Alarm clock based on Unix-sockets and python.

• Host: GitHub
• URL: https://github.com/s3rius/alarmix
• Owner: s3rius
• Created: 2020-11-12T04:14:32.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-18T06:38:31.000Z (almost 4 years ago)
• Last Synced: 2024-09-27T09:04:33.288Z (about 1 month ago)
• Topics: alarm, alarmclock, python3, sockets, unix, utility
• Language: Python
• Homepage:
• Size: 104 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
|py_versions| |build_statuses| |pypi_versions|

.. |py_versions| image:: https://img.shields.io/pypi/pyversions/alarmix?style=flat-square

    :alt: python versions

.. |build_statuses| image:: https://img.shields.io/github/workflow/status/s3rius/alarmix/Release%20python%20package?style=flat-square

    :alt: build status

.. |pypi_versions| image:: https://img.shields.io/pypi/v/alarmix?style=flat-square

    :alt: pypi version

    :target: https://pypi.org/project/alarmix/

.. image:: https://raw.githubusercontent.com/s3rius/alarmix/master/logo.png

    :alt: logo

    :align: center

===============

Installation

===============

.. code-block:: bash

    python -m pip install alarmix

⚠️ `MPV `_ must be installed and accessible ⚠️

At first, you need to start alarmd daemon:

.. code-block:: bash

    # Run alarmd-server as a daemon

    alarmd -s "path/to/sound/to/play" -d

    # To kill it you need to run

    alarmd kill

    # Of course you can see help

    alarmd -h

Then you can manage your alarms with `alarmc` command.

.. code-block:: bash

    alarmc # Show scheduled alarms for today

    alarmc -f # Show all scheduled alarms

    alarmc stop # Stop buzzing alarm

    alarmc add 20:00 19:30 14:00 # Add alarms

    alarmc add +30 +2:40 # Add alarms with relative time

    alarmc delete 20:00 # Remove alarm from schedule

    alarmc

    alarmc -h # Show help

Also alarmc can display information about your schedule in different formats:

.. code-block::

    ➜  ~ alarmc # Default schedule information

    +------------+----------------+

    | alarm time | remaining time |

    +------------+----------------+

    |  09:30:00  |    9:01:28     |

    +------------+----------------+

    ➜  ~ alarmc -r # Raw data without table formatting (separated by '\t' character)

    alarm time      remaining time

    09:30:00        9:00:43

    ➜  ~ alarmc -w # Show "When" column

    +------------+----------------+----------+

    | alarm time | remaining time |   when   |

    +------------+----------------+----------+

    |  09:30:00  |    8:58:58     | weekdays |

    +------------+----------------+----------+

    ➜  ~ alarmc -c # Show "Cancelled" column

    +------------+----------------+-----------+

    | alarm time | remaining time | cancelled |

    +------------+----------------+-----------+

    |  09:30:00  |    8:57:35     |   False   |

    +------------+----------------+-----------+

    # All options can be combined

    ➜  ~ alarmc -rwc

    alarm time      remaining time  when            cancelled

    09:30:00        8:58:15         weekdays        False