Skip to content

BFH-BTI7301-project1/ClockAlarm

Repository files navigation

License: GPL v3 Documentation Status Build Status Coverage Status

ClockAlarm

ClockAlarm is a cross-platform (linux, Windows, macOS) alarm manager that will help you improve your life organization. Define alerts and never miss events again.

Features

  • Simple / Periodic alerts
  • Works on Windows, macOS and Linux
  • Safe, corrupt-free and humanly readable database
  • Fully customizable alerts (sound, color, font, etc)

Content

Installation

Requirements

  • python => 3.6
  • pygame => 1.9.3
  • PyQt5 => 5.8.2
  • sip => 4.19.2
  • tinydb => 3.2.2
> pip3 install pygame pyqt5 sip tinydb
> git clone https://github.com/BFH-BTI7301-project1/ClockAlarm.git

Usage

> python3 bin/clockalarm

Development

To develop ClockAlarm and run the tests the following packages are necessary:

  • coverage >= 4.4.1
  • pytest >= 3.0.7
  • pytest-cov >= 2.5.1
  • pytest-qt >= 2.1.0
  • pytest-catchlog >= 1.2.2
  • coveralls >= 1.1

Run the following command:

> pip3 install -r stable-req.txt

Run the tests:

> py.test --cov-report term --cov=. _clockalarm/_tests --no-xvfb

Documentation

The documentation can either be found under docs/pdf/clockalarm_documentation.pdf or clockalarm.readthedocs.io

You can also compile it yourself. Make sure that Sphinx (>= 1.6.1) is installed. Then simply run make html in the /docsdirectory.

Bugs

Please open a new GitHub issue if you encounter any bugs.

About

Develop a replacement for the program „kAlarm“ distributed with the KDE desktop environment

Resources

License

Stars

Watchers

Forks

Packages

No packages published