Skip to content

Installation

Get started with Apaleo API Client quickly and easily. This type-safe, async SDK supports Python 3.10+ and can be installed using your preferred package manager.

Package Installation

This library is published to PyPI. All installation methods below resolve the package from PyPI.

poetry add apaleo-api-client

pip install apaleo-api-client

uv add apaleo-api-client

Core dependencies (automatically installed):

  • httpx: A fully featured HTTP client for Python—powers our async operations.
  • pydantic[email] (v2): Data validation and type safety using Python type annotations.
  • dacite: Converts dictionaries to dataclasses for seamless type conversion.
  • httpx-retries: Automatic retry logic for robust API calls.
  • polyfactory: Generates mock data for dry runs and testing.

If you've got Python 3.10+ and pip, uv, Poetry, or pipenv installed, you're good to go.

Next Steps

Now that you have the library installed:

  1. Learn the basics - Understand key concepts
  2. Explore examples - See practical usage patterns
  3. Read the API docs - Dive into the full API reference
  4. Join the community - Get help and contribute