Skip to main content
The Avala SDK is published to PyPI as avala and can be installed with any Python package manager.

Requirements

The Avala SDK requires Python 3.9 or higher. Check your version with python --version.
Core dependencies:
  • httpx>=0.24,<1 - HTTP client for API requests
  • pydantic>=2.0,<3 - Data validation and type safety

Install with pip

pip install avala

Install with CLI support

The SDK includes an optional command-line interface for quick operations. Install with the cli extra:
pip install avala[cli]
This adds:
  • click>=8.0 - CLI framework
  • rich>=13.0 - Rich terminal output
The CLI is great for exploring your datasets and creating exports without writing code. Try avala --help after installation.

Development installation

If you’re contributing to the SDK or need the development dependencies:
pip install avala[dev]
Development extras include:
  • pytest>=7 - Test framework
  • respx>=0.20 - HTTPX mocking for tests
  • mypy>=1 - Static type checker
  • ruff>=0.1 - Fast Python linter and formatter
  • pytest-asyncio>=0.21 - Async test support

Verify installation

Check that the SDK is installed correctly:
import avala
print(avala.__version__)  # Should print the installed version
If you installed the CLI extra:
avala --version

Virtual environments

Always install the SDK in a virtual environment to avoid conflicts with system packages.
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install avala

Upgrade to the latest version

Keep your SDK up to date to access new features and bug fixes:
pip install --upgrade avala

Next steps

Authentication

Configure your API key to start making requests

Build docs developers (and LLMs) love