Skip to main content

Provides a helper to create sessions for use with Ansys OpenAPI clients.

Project description

PyAnsys Python PyPI GH-CI MIT Black pre-commit.ci status

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-common

Alternatively, to install the latest development version from the OpenAPI-Common repository, run this command:

pip install git+https://github.com/ansys/openapi-common.git

To install a local development version with Git and Poetry, run these commands:

git clone https://github.com/ansys/openapi-common
cd openapi-common
poetry install

The 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys_openapi_common-2.3.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

ansys_openapi_common-2.3.0-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file ansys_openapi_common-2.3.0.tar.gz.

File metadata

  • Download URL: ansys_openapi_common-2.3.0.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ansys_openapi_common-2.3.0.tar.gz
Algorithm Hash digest
SHA256 d67cfc7b5a3451e6713c78db5f23d1c76e27969ad634fedcae614dac6cbdf671
MD5 87b628f20c2bdcc0af12ad4ba9ad716d
BLAKE2b-256 64f606d55d27327f6157339ede1f7b41818378bce2be67692a4eff2d57134fff

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_openapi_common-2.3.0.tar.gz:

Publisher: ci_cd.yml on ansys/openapi-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ansys_openapi_common-2.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_openapi_common-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af8afca22c9f4c6282b2dd0408e7c707d3a27654d79f2924dbe3458eb110c351
MD5 88d84ffd67d1094eeed5452fc03c8454
BLAKE2b-256 8a8804020e9240e5234b621a5e0dd44d5bbf5e373d245f01f90013c2308e9ab3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_openapi_common-2.3.0-py3-none-any.whl:

Publisher: ci_cd.yml on ansys/openapi-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page