OpenAPI-Common
OpenAPI Common is designed for use with the custom code generation template in the PyAnsys project. It provides the source code for an authentication-aware client for OpenAPI client libraries.
Background
A widely used standard for HTTP REST-style APIs is the OpenAPI standard, formerly known as Swagger. OpenAPI-Common is designed to be used alongside code generation tools to produce client libraries for HTTP APIs.
Because some Ansys products expose HTTP APIs rather than gRPC APIs, this Python library provides a common client to consume HTTP APIs, minimizing overhead and reducing code duplication.
OpenAPI-Common supports authentication with Basic, Negotiate, NTLM, and OpenID Connect. Most features of the underlying requests session are exposed for use. Some basic configuration is also provided by default.
Dependencies
The ansys.openapi.common package currently supports Python version 3.10 through 3.13.
Platform-specific Kerberos configuration
Kerberos authentication should be supported wherever the MIT or Heimdal Kerberos client can be installed. OpenAPI-Common has been tested on the platforms that follow. If you manage to use it on another platform, consider contributing installation steps for your platform by making a pull request.
Ubuntu 20.04
Ubuntu requires the gssapi Python module to be built from source. This requires the Kerberos headers, Python headers for the version of Python that you are using, and a supported compiler. (GCC works well.)
You should then be able to install this module with the [linux-kerberos] extra:
sudo apt install build-essentials python3.8-dev libkrb5-dev
pip install ansys-openapi-common[linux-kerberos]Once the installation completes, ensure that your krb5.conf file is set up correctly for your Kerberos configuration and that you have a valid keytab file, which is normally in /etc/krb5.keytab.
Installation
To install the latest OpenAPI-Common release from PyPI, run this command:
pip install ansys-openapi-commonAlternatively, to install the latest development version from the OpenAPI-Common repository, run this command:
pip install git+https://github.com/ansys/openapi-common.gitTo install a local development version with Git and Poetry, run these commands:
git clone https://github.com/ansys/openapi-common
cd openapi-common
poetry installThe preceding commands install the package in development mode so that you can modify it locally. Your changes are reflected in your Python setup after restarting the Python kernel.
Release files for ansys-openapi-common 2.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ansys_openapi_common-2.3.1.tar.gz | 28.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ansys_openapi_common-2.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 64.7 kB
Release files / ansys_openapi_common-2.3.1.tar.gz
| Download URL | ansys_openapi_common-2.3.1.tar.gz |
|---|---|
| Size | 28.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
68da40011fcd5e47596d8f024675e2a1bdd6fbc4038126e7684163dd2e3d6c54
|
|
BLAKE2b-256 checksum How to use checksums |
1fb601368d7510ff82d0ba2d328a654be5c712d7e55ead98b9113ba9564d7248
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2025.
Transparency logRelease files / ansys_openapi_common-2.3.1-py3-none-any.whl
| Download URL | ansys_openapi_common-2.3.1-py3-none-any.whl |
|---|---|
| Size | 35.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
05dcc0e0d2194a3bea9ad3ba59e927feb467184fff65378f20590a07d6189eca
|
|
BLAKE2b-256 checksum How to use checksums |
ba93d5bc711ed40fa8559a86d08959cce9870371b412a384ed580088cc5cb7a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 30, 2025.
Transparency log
