monday-client 0.1.75

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

monday.com API Client

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

Documentation

For detailed documentation, 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():
    monday_client = MondayClient(api_key='your_api_key_here')
    boards = await monday_client.boards.query(board_ids=[987654321, 876543210])
    items = await monday_client.items.query(item_ids=[123456789, 123456780])

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.
• ComplexityLimitExceeded: Raised when the complexity limit and max retries are exceeded.
• MutationLimitExceeded: Raised when the mutation limit and max retries are 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)

Or update an already existing logging config:

import logging.config

logging_config = config['logging']

logging_config['loggers'].update({
    'monday_client': {
        'handlers': ['file', 'console'],  # Use the same handlers as your main logger
        'level': 'INFO',  # Set appropriate level
        'propagate': False
    }
})

logging.config.dictConfig(logging_config)
logger = logging.getLogger(__name__)

Testing

This project uses pytest for all testing.

• Unit tests: Run all unit tests (default):

  python -m pytest
  

• Integration tests: Require a valid API key and explicit marking:

  # Set up environment variables
  export MONDAY_API_KEY=your_api_key
  export MONDAY_TEST_BOARD_ID=123456789
  
  # Run integration tests (requires -m integration flag)
  python -m pytest -m integration
  
  # Run specific integration test file
  python -m pytest tests/test_integration.py -m integration -v
  

• Mutation tests: Test data creation, updates, and deletion (requires write permissions):

  export MONDAY_API_KEY=your_api_key
  python -m pytest -m mutation
  

  ⚠️ Warning: These tests will create and delete real data on your monday.com account.

See docs/TESTING.md for more details on test types, configuration, and best practices.

Development Setup

For development and testing, install with development dependencies:

pip install -e ".[dev]"

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub or see CONTRIBUTING.md for guidelines.

Support

For questions or support, open an issue on GitHub Issues.

License

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