https://github.com/prahladyeri/gar-cron

A script to send you reminders about your github commit activity
https://github.com/prahladyeri/gar-cron

cron github python reminders

Last synced: 10 months ago
JSON representation

A script to send you reminders about your github commit activity

• Host: GitHub
• URL: https://github.com/prahladyeri/gar-cron
• Owner: prahladyeri
• License: mit
• Created: 2019-06-08T17:27:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T03:32:36.000Z (over 4 years ago)
• Last Synced: 2025-03-21T02:22:10.361Z (11 months ago)
• Topics: cron, github, python, reminders
• Language: Python
• Homepage: https://github.com/prahladyeri/gar-cron
• Size: 23.4 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![pypi](https://img.shields.io/pypi/v/gar-cron.svg)

![python](https://img.shields.io/pypi/pyversions/gar-cron.svg)

![implementation](https://img.shields.io/pypi/implementation/gar-cron.svg)

![docs](https://readthedocs.org/projects/gar-cron/badge/?version=latest)

![license](https://img.shields.io/github/license/prahladyeri/gar-cron.svg)

![last-commit](https://img.shields.io/github/last-commit/prahladyeri/gar-cron.svg)

[![patreon](https://img.shields.io/badge/Patreon-brown.svg?logo=patreon)](https://www.patreon.com/prahladyeri)

[![paypal](https://img.shields.io/badge/PayPal-blue.svg?logo=paypal)](https://paypal.me/prahladyeri)

[![follow](https://img.shields.io/twitter/follow/prahladyeri.svg?style=social)](https://twitter.com/prahladyeri)

# gar-cron

github activity reminder cron - a script to send you reminders about your github commit activity. By default, it shoots a mail when there is no commit activity for 3 or more days. [Read this DEV.to article to understand more about this tool](https://dev.to/prahladyeri/gar-cron-a-python-script-to-remind-you-about-your-github-activity-22ad).

# Installation

	pip install gar-cron

# Usage

	gar-cron

# Configuration

When you run gar-cron for the first time, it will prompt you to set values in `config.json` along with its path. The values you need to set should be as follows (You need an smtp mail account to shoot emails, popular ones like GMail/Hotmail don't support this without oAuth, so register one at [gmx.com](https://gmx.com) or something):

	{

		"github_username": "",

		"alert_email": "",

		"smtp_server":"",

		"smtp_email": "",

		"smtp_username": "",

		"smtp_password": "",

		"smtp_port": ""

	}

Once you do this, run `gar-cron` again to ensure that it works. You may then configure it as a user cron job on linux by running `crontab -e` or on windows by scheduling it through the control panel.

For testing of email reminder, you may temporarily configure someone else's `github_username` in config.json who hasn't committed since a long time before running it.