gcsa


Namegcsa JSON
Version 2.2.0 PyPI version JSON
download
home_pagehttps://github.com/kuzmoyev/google-calendar-simple-api
SummarySimple API for Google Calendar management
upload_time2023-11-13 13:22:56
maintainer
docs_urlNone
authorYevhen Kuzmovych
requires_python
licenseMIT
keywords python conference calendar hangouts python-library event conferences google-calendar pip recurrence google-calendar-api attendee gcsa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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 its 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": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "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/c2/de/72cda65fb5cd7d53f7cb52e19f1861fc68451a5c3bba5c297cabafdc5092/gcsa-2.2.0.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 its 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.2.0",
    "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": "111e15280e4c2c969217e3100bc24adad929658c8e1e79cc3321ebbe6cc9839a",
                "md5": "98010aa03b9087822f9447bffcfa61cd",
                "sha256": "8fb785e5f5692c32d8b28d9c94bc6904bec5232b06fc2de27f010d6abef3ea70"
            },
            "downloads": -1,
            "filename": "gcsa-2.2.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "98010aa03b9087822f9447bffcfa61cd",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 46892,
            "upload_time": "2023-11-13T13:22:54",
            "upload_time_iso_8601": "2023-11-13T13:22:54.190285Z",
            "url": "https://files.pythonhosted.org/packages/11/1e/15280e4c2c969217e3100bc24adad929658c8e1e79cc3321ebbe6cc9839a/gcsa-2.2.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c2de72cda65fb5cd7d53f7cb52e19f1861fc68451a5c3bba5c297cabafdc5092",
                "md5": "b05083e87a7c812141f337978fa2e5c0",
                "sha256": "b4006966f76d1de860830e9a964436ec6e8bac9cc94c76c2bc310fb5a87214e8"
            },
            "downloads": -1,
            "filename": "gcsa-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b05083e87a7c812141f337978fa2e5c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 48594,
            "upload_time": "2023-11-13T13:22:56",
            "upload_time_iso_8601": "2023-11-13T13:22:56.503578Z",
            "url": "https://files.pythonhosted.org/packages/c2/de/72cda65fb5cd7d53f7cb52e19f1861fc68451a5c3bba5c297cabafdc5092/gcsa-2.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-13 13:22: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"
}
        
Elapsed time: 0.13796s