https://github.com/kuzmoyev/google-calendar-simple-api

Pythonic wrapper for the Google Calendar API
https://github.com/kuzmoyev/google-calendar-simple-api

access-control-list acl attendee calendar conference conferences event freebusy gcsa google-calendar google-calendar-api hangouts pip python python-library recurrence

Last synced: about 1 month ago
JSON representation

Pythonic wrapper for the Google Calendar API

• Host: GitHub
• URL: https://github.com/kuzmoyev/google-calendar-simple-api
• Owner: kuzmoyev
• License: mit
• Created: 2017-02-24T13:46:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-08T07:09:32.000Z (5 months ago)
• Last Synced: 2024-07-18T20:35:14.604Z (5 months ago)
• Topics: access-control-list, acl, attendee, calendar, conference, conferences, event, freebusy, gcsa, google-calendar, google-calendar-api, hangouts, pip, python, python-library, recurrence
• Language: Python
• Homepage: https://google-calendar-simple-api.readthedocs.io
• Size: 554 KB
• Stars: 531
• Watchers: 10
• Forks: 42
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• my-awesome-github-stars - kuzmoyev/google-calendar-simple-api - Pythonic wrapper for the Google Calendar API (Python)

README

        
Google Calendar Simple API

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

.. image:: https://badge.fury.io/py/gcsa.svg

    :target: https://badge.fury.io/py/gcsa

    :alt: PyPi Package

.. image:: https://readthedocs.org/projects/google-calendar-simple-api/badge/?version=latest

    :target: https://google-calendar-simple-api.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

.. image:: https://github.com/kuzmoyev/Google-Calendar-Simple-API/workflows/Tests/badge.svg

    :target: https://github.com/kuzmoyev/Google-Calendar-Simple-API/actions

    :alt: Tests

.. image:: https://badgen.net/badge/icon/discord?icon=discord&label

    :target: https://discord.gg/mRAegbwYKS

    :alt: Discord

`Google Calendar Simple API` or `gcsa` is a library that simplifies event and calendar management in Google Calendars.

It is a Pythonic object oriented adapter for the official API. See the full `documentation`_.

Installation

------------

.. code-block:: bash

    pip install gcsa

See `Getting started page`_ for more details and installation options.

Example usage

-------------

List events

~~~~~~~~~~~

.. code-block:: python

    from gcsa.google_calendar import GoogleCalendar

    calendar = GoogleCalendar('[email protected]')

    for event in calendar:

        print(event)

Create event

~~~~~~~~~~~~

.. code-block:: python

    from gcsa.event import Event

    event = Event(

        'The Glass Menagerie',

        start=datetime(2020, 7, 10, 19, 0),

        location='Záhřebská 468/21',

        minutes_before_popup_reminder=15

    )

    calendar.add_event(event)

Create recurring event

~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    from gcsa.recurrence import Recurrence, DAILY

    event = Event(

        'Breakfast',

        start=date(2020, 7, 16),

        recurrence=Recurrence.rule(freq=DAILY)

    )

    calendar.add_event(event)

**Suggestion**: use beautiful_date_ to create `date` and `datetime` objects in your

projects (*because it's beautiful... just like you*).

References

----------

Template for `setup.py` was taken from `kennethreitz/setup.py`_

.. _documentation: https://google-calendar-simple-api.readthedocs.io/en/latest/?badge=latest

.. _`Getting started page`: https://google-calendar-simple-api.readthedocs.io/en/latest/getting_started.html

.. _beautiful_date: https://github.com/kuzmoyev/beautiful-date

.. _`kennethreitz/setup.py`: https://github.com/kennethreitz/setup.py