Installation

From PyPI (recommended)

pip install accordionq2

From Source

Clone the repository and install in editable mode (recommended during development):

git clone https://github.com/esharpab/esharp-accordion-projects-webapiclient-python.git
cd esharp-accordion-projects-webapiclient-python
pip install -e .

Or install without editable mode:

pip install .

Using uv (recommended for development)

uv is a fast Python package manager:

# Install uv
pip install uv

# Create a virtual environment and install the package
uv venv
uv pip install -e .

Development Setup

Install with all development dependencies (linting, type checking, tests):

pip install -e ".[dev]"

This installs:

• pytest — test runner
• ruff — linter and formatter
• mypy — static type checker
• pre-commit — git hook runner

To activate pre-commit hooks:

pre-commit install

Requirements

Verifying the Installation

import accordionq2
print(accordionq2.__version__)

.NET Alternative

If you are working in a .NET environment, the equivalent package is available on NuGet:

dotnet add package AccordionQ2.WebApiClient

See the .NET comparison for a side-by-side feature comparison.