Metadata-Version: 2.4
Name: certaraiq
Version: 3.0.0a5
Summary: A Python client for the Certara IQ platform
Author: Certara IQ Support
Author-email: Certara IQ Support <iq-support@certara.com>
License-Expression: LicenseRef-Proprietary
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Dist: httpx2==2.*
Requires-Dist: ipython==9.*
Requires-Dist: numpy==2.*
Requires-Dist: ordered-set==4.*
Requires-Dist: pandas==3.*
Requires-Dist: parsita==2.3.*
Requires-Dist: pint==0.25.*
Requires-Dist: prettytable==3.*
Requires-Dist: scipy==1.*
Requires-Dist: serialite==0.6.*
Requires-Dist: tabeline[pandas,polars]==0.7.*
Requires-Python: ==3.14.*
Project-URL: Repository, https://github.com/certara/certara-iq-v2
Description-Content-Type: text/markdown

# Certara IQ Python client

This is a Python client for the Certara IQ platform. It is useless alone and must be
installed in an environment with a valid access token to a deployed Certara IQ server.

## Configuration

The client searches the following paths for a configuration file:

```
${XDG_CONFIG_HOME:-~/.config}/certaraiq/client.toml

/etc/certaraiq/client.toml
```

Example configuration file:

```toml
api_origin = 'https://dev01.dev-abm.com'
iq_session_path = '/etc/certaraiq/iq_session'
```

- `api_origin`: The protocol and host for the Certara IQ server API. All requests will be made against this API. By
  default, the client will request against `http://localhost:5200`.
- `iq_session_path`: Path to a file containing the `iq_session` cookie value. The client sends it as
  `Cookie: iq_session=<value>` so the auth gateway resolves the same session the browser holds. By default, the client
  attempts requests with no authentication.

The search stops at the first configuration file found. If no configuration file is found, the defaults for
all values are used.

## Test the local client in Analyze

By default, Analyze notebooks use the PyPI `certaraiq` release. To use this checkout instead, start the stack with the
local client:

```sh
just up --local-client
```

If you run the Python backend outside Compose, use `just up minimal --local-client` instead.

Then reopen a notebook and import `certaraiq`. Check that `certaraiq.__file__` starts with `/opt/python-client/`. After
source edits, restart the kernel. To return to the PyPI release, run `just up` and reopen your notebooks.

The project environment supplies dependencies. If you change dependencies in `pyproject.toml`, update them in
**Packages** too.
