Required: Python 3.9+

From PyPI:

pip3 install indico-client

From source:

Using UV (recommended):

# Install UV if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

git clone https://github.com/IndicoDataSolutions/indico-client-python.git
cd indico-client-python
uv pip install -e ".[all]"

Or using pip:

git clone https://github.com/IndicoDataSolutions/indico-client-python.git
cd indico-client-python
pip install -e ".[all]"

Running in a Docker container:

docker build -t indico-client .
docker run -it indico-client bash

The Indico Platform and Client Libraries use JSON Web Tokens (JWT) for user authentication. Details on acquiring this token can be found at this documentation

The following environment variables are used for authentication in the default IndicoClient object

• INDICO_HOST: URL of the IPA instance
• INDICO_API_TOKEN: user token downloaded from these directions

from indico import IndicoClient, IndicoConfig

config = IndicoConfig(
    host='try.indico.io', # or your custom app location
    api_token_path='./indico_api_token.txt' # path to your API token
    )
client = IndicoClient(config=config)

from indico import IndicoClient
from indico.client.request import GraphQLRequest

client = IndicoClient()
response = client.call(GraphQLRequest(
    query="""
        query modelGroupQueries($ids: [Int]) {
	        modelGroups(modelGroupIds: $ids){
                modelGroups{
                    id
                }
            }
        }
    """,
    variables={"ids": [1]}
))

model_groups = response["model_groups"]["model_groups"]

To run the tests associated with this repo perform the following:

Ensure you have set the environment variables detailed here

You will also need the following env variables set for the Exchange integration tests:

• EXCH_TENANT_ID
• EXCH_CLIENT_ID
• EXCH_CLIENT_SECRET
• EXCH_USER_ID

Using UV (recommended):

1. Install UV if you haven't already curl -LsSf https://astral.sh/uv/install.sh | sh
2. Install the client and test dependencies uv pip install -e ".[all]" "pytest<8" "requests-mock>=1.8.0" "pytest-asyncio>0.21"
3. Run tests pytest -sv --host <indico_host> tests/ _ Only run unit tests pytest -sv --host <indico_host> tests/unit/ _ Only run integration tests pytest -sv --host <indico_host> tests/integration/
4. Check typing

   uv pip install "mypy==1.8" typing_extensions pandas-stubs types-requests types-pytz types-openpyxl
   mypy --config-file=pyproject.toml

Or using pip:

1. Create a virtual environment python3 -m venv venv
2. Activate the virtual environment source venv/bin/activate
3. Install the client pip3 install --editable .[all]
4. Install test deps pip3 install "pytest<8" "requests-mock>=1.8.0" "pytest-asyncio>0.21"
5. Run tests pytest -sv --host <indico_host> tests/ _ Only run unit tests pytest -sv --host <indico_host> tests/unit/ _ Only run integration tests pytest -sv --host <indico_host> tests/integration/
6. Check typing

   pip3 install "mypy==1.8" typing_extensions pandas-stubs types-requests types-pytz types-openpyxl
   mypy --config-file=pyproject.toml

Alternatively, run all the unit tests via docker compose run --rm tester

This repository adheres (as best as possible) to the following standards:

• Python Black Formatter
  • Line Width=88
• Google Docstrings