Skip to content

README.md

Latest commit

 

History

History
58 lines (42 loc) · 1.21 KB

README.md

File metadata and controls

58 lines (42 loc) · 1.21 KB

XKCD Notifier

Receive notifications when XKCD releases!

Table of contents

About

XKCD Notifier is a lightweight tool that sends you desktop notifications when a new XKCD comic is published.
It uses the notifypy module for cross-platform notification support.

Features

  • Sends desktop notifications on comic release.
  • Polls XKCD API periodically.
  • Simple, lightweight, and easy to run.

Installation

Clone the Repository

git clone https://github.com/SlothScript/XKCD-Notifier.git
cd XKCD-Notifier

Install Dependancies

pip install notifypy

Requirements

XKCD Notifier requires notifypy as a backend for sending desktop notifications. Use pip install notifypy to get it.

Usage

Use python XKCDNotifier.py and you will see a prompt pop-up that says Next check: 5:00 or Not a release day.

Contributing

Create a issue or pull request to help!

Contact

You can contact me by creating an issue, or emailing ethanridgewell225@gmail.com