Skip to main content

Python library for interacting with the monday.com API. Respects monday.com API rate limits and query complexity limits.

Project description

Monday.com API Client

Monday.com API Client Logo

Documentation Status PyPI version Python Versions License: GPL v3 GitHub issues GitHub last commit

This Python library provides an asynchronous client to interact with the Monday.com API.

Documentation

For detailed documentation, please visit the official documentation site.

Key Features

  • Asynchronous API calls using asyncio and aiohttp for efficient I/O operations.
  • Automatic handling of API rate limits and query limits following Monday.com's rate limit policies.
  • Built-in retry logic for handling rate limit exceptions, ensuring smooth operation without manual intervention.
  • Easy-to-use methods for common Monday.com operations.
  • Fully customizable requests with all Monday.com method arguments and fields available to the user.

Installation

pip install monday-client

Quick Start

import asyncio

from monday import MondayClient

async def main():
    client = MondayClient(api_key='your_api_key_here')
    boards = await client.boards.query(board_ids=[1234567890, 1234567891])
    items_page = await client.items.items_page(board_ids=[1234567890, 1234567891])

asyncio.run(main())

Usage

Asynchronous Operations

All methods provided by the MondayClient are asynchronous and should be awaited. This allows for efficient concurrent execution of API calls.

Rate Limiting and Retry Logic

The client automatically handles rate limiting in compliance with Monday.com's API policies. When a rate limit is reached, the client will wait for the specified reset time before retrying the request. This ensures that your application doesn't need to manually handle rate limit exceptions and can operate smoothly.

Error Handling

Custom exceptions are defined for handling specific error cases:

  • MondayAPIError: Raised when an error occurs during API communication with Monday.com.
  • PaginationError: Raised when item pagination fails during a request.
  • QueryFormatError: Raised when there is a query formatting error.

These exceptions are handled internally by the client during retries. If the maximum number of retries is exceeded, the client will return an error response.

  • ComplexityLimitExceeded: Raised when the complexity limit is exceeded.
  • MutationLimitExceeded: Raised when the mutation limit is exceeded.

Logging

The client uses a logger named monday_client for all logging operations. By default, a NullHandler is added to suppress logging output. To enable logging, you can configure the logger in your application:

import logging

logger = logging.getLogger('monday_client')
logger.setLevel(logging.INFO)
handler = logging.StreamHandler()
handler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
logger.addHandler(handler)

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monday_client-0.1.45.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

monday_client-0.1.45-py3-none-any.whl (58.0 kB view details)

Uploaded Python 3

File details

Details for the file monday_client-0.1.45.tar.gz.

File metadata

  • Download URL: monday_client-0.1.45.tar.gz
  • Upload date:
  • Size: 38.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for monday_client-0.1.45.tar.gz
Algorithm Hash digest
SHA256 4d69de793ea2910839dfdf4bc53af3d117d8fd0dd183e627eddd09fdfac85b68
MD5 18d6539be57f3b5170ffafb6ce9a404a
BLAKE2b-256 033407bf0f5f6db40d6b2968f6a9eff4c8dfc4bc37f532e735f81e9c219396a6

See more details on using hashes here.

File details

Details for the file monday_client-0.1.45-py3-none-any.whl.

File metadata

File hashes

Hashes for monday_client-0.1.45-py3-none-any.whl
Algorithm Hash digest
SHA256 695c516ff93dbf517e9a3af1209a8337f48bee0e5e6ff410288c04769c4fd57c
MD5 5987e8f7cb9810c91b7f703323b7eb65
BLAKE2b-256 18be3c0852b565c0ddbd85461502702347f08528fa7a287cf61edf283c146677

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page