Skip to main content

Getting Started with Calendar API

Introduction

Manipulates events and other calendar data. Provides access to Google Calendar for creating, listing, patching, and deleting events, querying free/busy information, and setting up push notifications for event changes.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install google-calendar-apimatic-sdk==1.0.3

You can also view the package at: https://pypi.python.org/pypi/google-calendar-apimatic-sdk/1.0.3

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 30
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
authorization_code_auth_credentials AuthorizationCodeAuthCredentials The credential object for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from calendarapi.calendarapi_client import CalendarapiClient
from calendarapi.configuration import Environment
from calendarapi.http.auth.oauth_2 import AuthorizationCodeAuthCredentials
from calendarapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from calendarapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from calendarapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from calendarapi.models.oauth_scope import OauthScope

client = CalendarapiClient(
    authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScope.HTTPS_WWW_GOOGLEAPIS_COM_AUTH_CALENDAR_READONLY,
            OauthScope.HTTPS_WWW_GOOGLEAPIS_COM_AUTH_CALENDAR_EVENTS
        ]
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from calendarapi.calendarapi_client import CalendarapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = CalendarapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default Google Calendar API v3

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for google-calendar-apimatic-sdk 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for google-calendar-apimatic-sdk 1.0.3
File Size Uploaded Provenance Actions
google_calendar_apimatic_sdk-1.0.3.tar.gz 55.5 kB Without provenance Details for google_calendar_apimatic_sdk-1.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for google-calendar-apimatic-sdk 1.0.3
File Interpreter ABI Platform Actions
google_calendar_apimatic_sdk-1.0.3-py3-none-any.whl Python 3 none any Details for google_calendar_apimatic_sdk-1.0.3-py3-none-any.whl

Total release size: 178.5 kB

Release files / google_calendar_apimatic_sdk-1.0.3.tar.gz

Download URL google_calendar_apimatic_sdk-1.0.3.tar.gz
Size 55.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0877b6a6b62547a1ff8ad0e5e647158569407bf17a10ab56937f3502b914abbc
BLAKE2b-256 checksum
How to use checksums
8624ab60671409a5557573d8df3b91775fad7bfab84d0fd52a8a35bccdf75ea6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / google_calendar_apimatic_sdk-1.0.3-py3-none-any.whl

Download URL google_calendar_apimatic_sdk-1.0.3-py3-none-any.whl
Size 123.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0a39a03358afd6e869089ad6fdb7de6247ca007e9c89529f4a7de3cd782a68e9
BLAKE2b-256 checksum
How to use checksums
2c7a139bcaece1f932d1b0bd2dcd1ecda9a602d3d31b7511c205d94c3bfb43a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for google-calendar-apimatic-sdk 1.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page