ant_connect_py

ant_connect_py Python package V2 is here!

ant_connect_py V2 is a ground-up rewrite that offers some breaking changes compared to the previous version. The new version is designed to be more flexible, more efficient, and especially more user-friendly. The new version is also designed to be more modular, allowing users to easily extend the functionality of the package.

Note

If you are using ant_connect V1 (versions 2023.15.1 and lower) you might want to check the documentation for more details. ant_connect_py V2 also ships with the latest version of ant_connect V1 built in so that you can incrementally upgrade your code base and projects.

Import as follows: from ant_connect import v1 as ant_connect_v1

This repo contains a centralized changelog file, CHANGELOG.rst, which is used to track changes to the project. The file is automatically updated in the pipeline with each release, and includes a list of changes, bug fixes, and new features for each version of the project.

The reason to use a centraized changelog file (found on the centralized-changelog branch) is to provide a single source of truth for all changes to the project and all future releases.

Of course, I would not be an epic developer if I would not consider your need to manually add changes to the changelog for the coming release. List your changes below!

ADD TO THE CHANGELOG (every line from line 15 will be added to the changelog)

v2.0.12rc302 (2026-09-18)

Restores the package: every API call in 2.0.12rc* up to and including rc301 failed with TypeError: 'ModelPrivateAttr' object is not iterable. Also the first regeneration of models.py since the generator stopped working, so it tracks the current API again.

Bug Fixes

ApiConnector declared its connection state as underscore-prefixed attributes without ClassVar, so Pydantic v2 collected them as private attributes. activate() then handed a ModelPrivateAttr to ModelBaseClass._cookies and requests tried to iterate it. Every API call failed this way.
Project.description and Project.number are nullable in the API but were declared as required str, so a project with either field null failed validation.
The model generator could not run against the live spec at all, which is why models.py had gone stale: a 204-only endpoint dereferenced None, text/csv responses matched no branch, and a bare OA\Items serialised to [] rather than {}.

New Features

New models: VaultSecret, VaultSecretGrant, VaultSecretUsage, VaultProviderPreset, VaultCredentialDetection, WebhookTrigger, WebhookTriggerSecret, WebhookTriggerVersion, WebhookBindingTestResult, PropagationRun, PropagationRunItem, PropagationTemplate, PropagationTemplateItem, UserNotificationRule, OAuthClient.
Roughly a hundred endpoints that existed on the API but not in the SDK are now generated, across Task (versioning, shares, relation queries), Table (locking, queries), Script, Revision, Label, DmsFile (external links, root upload), Project (archive, project users) and AntPersonalAccessToken.

Breaking Changes

Removed models, no longer present in the API spec: Module, Permission, Member, Link, Company, NewsItem, LabelOs, Workflow, WorkflowCollection, Reseller, ResellerRequest, SbsVersion, AntPersonalAccessTokenResult.
Label.title renamed to Label.name.
Project.modules removed.
User.company is now Optional[str] (was Optional[dict]).
License.authorize_user() and Task.update_dates() removed.
Project.description and Project.number are now Optional[str]. They are nullable in the API and the previous required declaration rejected valid responses.

v2.0.11 (2026-03-19)

New Features

Added context helper methods to ApiConnector for license/project scoping: set_license_context(), set_project_context(), clear_license_context(), clear_project_context(), set_cookies(), get_cookies(), clear_cookies(). All API calls can now be scoped to a specific license and/or project via cookies.

Breaking Changes

Dropped support for Python 3.8 and 3.9. Minimum version is now Python 3.10.
numpy (^2.1.0) and pandas (^2.2.3) are now runtime dependencies (previously dev-only). This increases the install footprint.
Minimum pydantic version raised from ^2.5.2 to ^2.8.0.

Improvements

Added official support for Python 3.13 and 3.14.
Migrated CI/CD pipeline from GitLab CI to GitHub Actions.
Updated dev dependencies: pylint ^3.3.0, black ^24.8.0, sphinx ^7.3.0.
Added AI_DOCUMENTATION.md as architecture guide for AI-assisted development.
Updated package metadata and documentation URLs.

Release files for ant_connect_py 2.0.12rc326

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ant_connect_py 2.0.12rc326
File	Size	Uploaded
ant_connect_py-2.0.12rc326.tar.gz	48.9 kB	Sep 25, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ant_connect_py 2.0.12rc326
File	Interpreter	ABI	Platform	Reset
ant_connect_py-2.0.12rc326-py3-none-any.whl 51.7 kB Sep 25, 2026	Python 3	none	any	Details

Total release size: 100.5 kB

Release files / ant_connect_py-2.0.12rc326.tar.gz

Download URL	ant_connect_py-2.0.12rc326.tar.gz
Size	48.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`e2f31be2e27673ec47b43994444144bbcd674d161ac124be1a0f4034f8e2104a`
BLAKE2b-256 checksum How to use checksums	`9c175519c65bdcd12ebee738dfc70dc16d8aadb2f9a4a861233cf39dcaa90fd4`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure`

Release files / ant_connect_py-2.0.12rc326-py3-none-any.whl

Download URL	ant_connect_py-2.0.12rc326-py3-none-any.whl
Size	51.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2a1add7d83196a193f102d7357ab690e46b1ae9195793c2e90edf12d82bae6ff`
BLAKE2b-256 checksum How to use checksums	`bd8d253d8c59282c8b41fcf91fa757927f7a916df8aaf5706097782c1ab5af67`
Upload date	Sep 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure`