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('your_email@gmail.com')
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
Raw data
{
"_id": null,
"home_page": "https://github.com/kuzmoyev/google-calendar-simple-api",
"name": "gcsa",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python conference calendar hangouts python-library event conferences google-calendar pip recurrence google-calendar-api attendee gcsa",
"author": "Yevhen Kuzmovych",
"author_email": "kuzmovych.yevhen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ea/9e/77c8d6205ed0fb9ee5f886421c95f2ef7098550b91a4264237687aeee956/gcsa-2.5.1.tar.gz",
"platform": null,
"description": "Google Calendar Simple API\n==========================\n\n.. image:: https://badge.fury.io/py/gcsa.svg\n :target: https://badge.fury.io/py/gcsa\n :alt: PyPi Package\n\n.. image:: https://readthedocs.org/projects/google-calendar-simple-api/badge/?version=latest\n :target: https://google-calendar-simple-api.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://github.com/kuzmoyev/Google-Calendar-Simple-API/workflows/Tests/badge.svg\n :target: https://github.com/kuzmoyev/Google-Calendar-Simple-API/actions\n :alt: Tests\n\n.. image:: https://badgen.net/badge/icon/discord?icon=discord&label\n :target: https://discord.gg/mRAegbwYKS\n :alt: Discord\n\n\n`Google Calendar Simple API` or `gcsa` is a library that simplifies event and calendar management in Google Calendars.\nIt is a Pythonic object oriented adapter for the official API. See the full `documentation`_.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install gcsa\n\nSee `Getting started page`_ for more details and installation options.\n\nExample usage\n-------------\n\nList events\n~~~~~~~~~~~\n\n.. code-block:: python\n\n from gcsa.google_calendar import GoogleCalendar\n\n calendar = GoogleCalendar('your_email@gmail.com')\n for event in calendar:\n print(event)\n\n\nCreate event\n~~~~~~~~~~~~\n\n.. code-block:: python\n\n from gcsa.event import Event\n\n event = Event(\n 'The Glass Menagerie',\n start=datetime(2020, 7, 10, 19, 0),\n location='Z\u00e1h\u0159ebsk\u00e1 468/21',\n minutes_before_popup_reminder=15\n )\n calendar.add_event(event)\n\n\nCreate recurring event\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from gcsa.recurrence import Recurrence, DAILY\n\n event = Event(\n 'Breakfast',\n start=date(2020, 7, 16),\n recurrence=Recurrence.rule(freq=DAILY)\n )\n calendar.add_event(event)\n\n\n**Suggestion**: use beautiful_date_ to create `date` and `datetime` objects in your\nprojects (*because it's beautiful... just like you*).\n\n\nReferences\n----------\n\nTemplate for `setup.py` was taken from `kennethreitz/setup.py`_\n\n\n.. _documentation: https://google-calendar-simple-api.readthedocs.io/en/latest/?badge=latest\n.. _`Getting started page`: https://google-calendar-simple-api.readthedocs.io/en/latest/getting_started.html\n.. _beautiful_date: https://github.com/kuzmoyev/beautiful-date\n.. _`kennethreitz/setup.py`: https://github.com/kennethreitz/setup.py\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple API for Google Calendar management",
"version": "2.5.1",
"project_urls": {
"Homepage": "https://github.com/kuzmoyev/google-calendar-simple-api"
},
"split_keywords": [
"python",
"conference",
"calendar",
"hangouts",
"python-library",
"event",
"conferences",
"google-calendar",
"pip",
"recurrence",
"google-calendar-api",
"attendee",
"gcsa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1695c1fbc94aee80c1dbf363fd258be47ca860d386217e6e8202eac4482caaa",
"md5": "f744dbea6da7b2d1a8791b14e4a344f1",
"sha256": "4e29dc38bfa7ac0049e0230201567e9794af1d4f9829f65e2182e5ee57ef24d9"
},
"downloads": -1,
"filename": "gcsa-2.5.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f744dbea6da7b2d1a8791b14e4a344f1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 48970,
"upload_time": "2024-11-01T10:43:54",
"upload_time_iso_8601": "2024-11-01T10:43:54.152544Z",
"url": "https://files.pythonhosted.org/packages/a1/69/5c1fbc94aee80c1dbf363fd258be47ca860d386217e6e8202eac4482caaa/gcsa-2.5.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea9e77c8d6205ed0fb9ee5f886421c95f2ef7098550b91a4264237687aeee956",
"md5": "3710f00b8581570b412aecd2c090c422",
"sha256": "ddad61c418b5c471872e8201293dc948fb5cf2f54635b8e53e874959aebba6a7"
},
"downloads": -1,
"filename": "gcsa-2.5.1.tar.gz",
"has_sig": false,
"md5_digest": "3710f00b8581570b412aecd2c090c422",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 52418,
"upload_time": "2024-11-01T10:43:56",
"upload_time_iso_8601": "2024-11-01T10:43:56.619163Z",
"url": "https://files.pythonhosted.org/packages/ea/9e/77c8d6205ed0fb9ee5f886421c95f2ef7098550b91a4264237687aeee956/gcsa-2.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 10:43:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kuzmoyev",
"github_project": "google-calendar-simple-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "gcsa"
}
JSON
