Skip to content

Latest commit

 

History

History
189 lines (125 loc) · 6.13 KB

README.md

File metadata and controls

189 lines (125 loc) · 6.13 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Google Calendar Conflict Detector

A simple script that reads your google calendar for the next day and checks for conflicts. In the case of a conflict you can choose to be notified via iMessage and/or a notification.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Product Name Screen Shot

Getting Started

Compatibility

At this time the Conflict Detector is only compatible with Mac OS.

Prerequisites

  • A Google account and calendar

  • Pip

Installation

  1. Clone the repo
git clone https://github.com/jmmander/Google-Calendar-Conflict-Detector.git

  1. Go to https://developers.google.com/calendar/quickstart/python and turn on the Google Calendar API:

    1. Follow the instructions in Step 1: Turn on the Google Calendar API.
    2. Click Enable Google Calendar API
    3. You may name the project whatever you wish.
    4. Select Desktop App under Configure Your OAuth Client and click Create.
    5. Click Download Client Configuration and save the file credentials.json in the same folder as cal.py

  2. Install the Google Client Library as per step 2 in the Google Calendar API documentation:

pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
  1. Open the terminal and run cal.py
python cal.py
  1. Answer the questions in the terminal when prompted
Would you like an iMessage notication? (y/n)   n

  1. Once answered a browser window should open and prompt you to authorize access to your google calendar. Ensure you select the google account that your calendar is associated with. ![Google Account Screen Shot]

  2. If you are monitoring more than one google calendar (as indicated in the first question) more browser windows will open. Authorize these in the same way.

  3. You will also get a pop up in MacOs authorizing the cron job. Accept this to automatically run the script hourly and check your calendar for conflicts.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - JMander

Project Link: https://github.com/jmmander/Google-Calendar-Conflict-Detector

Acknowledgements