---
id: tapipy
version: "25.4.0"
license: BSD-4-Clause
license_treatment: permissive
maintenance: active
---

# tapipy — Python lib for interacting with an instance of the Tapis API Framework

License: permissive · Maintenance: active · Downloads: 83.6K/mo

## What it is and what it does

Tapipy is a Python SDK that bridges your code to Tapis API Framework services by automatically generating client bindings from OpenAPI specifications. You initialize a Tapis object with your tenant URL and credentials, call get_tokens() to authenticate, and then invoke service methods directly on the object—for example, t.sk.hasRole() or t.jobs.getJobSearchList(). The library handles token refresh automatically, so your authenticated session stays valid without manual intervention.

The SDK supports customization through resource sets (master or dev), custom spec dictionaries for overriding or adding service definitions, and local spec files. It uses cloudpickle to cache downloaded OpenAPI specs, reducing initialization overhead on subsequent runs. Special keyword arguments _tapis_headers and _tapis_query_parameters let you pass parameters not defined in the OpenAPI spec, useful for search endpoints and other dynamic query needs.

Use it for:

- Authenticate and interact with TACC's Tapis services (SK, jobs, etc.) from Python scripts or applications.
- Build automation tools that need to query job status, manage roles, or interact with multiple Tapis microservices.
- Integrate Tapis API calls into data processing pipelines where token management and service discovery must be automatic.
- Develop client applications against a custom Tapis deployment by pointing to local or alternative OpenAPI spec files.
- Test Tapis service endpoints programmatically without writing raw HTTP requests or managing authentication tokens manually.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Tapipy is a Python SDK that automatically generates client bindings from OpenAPI specifications to interact with Tapis API Framework services, handling authentication and token refresh transparently.

Yes. Tapipy is actively maintained, has no known vulnerabilities, and offers low installation friction. It is the natural choice if you need to interact with Tapis services from Python—it eliminates boilerplate authentication and HTTP handling. The permissive BSD-4-Clause license poses no restriction. Install it if you are working with a Tapis instance; skip it only if you are building against a different API framework.

## Install

pip install tapipy
uv add tapipy
poetry add tapipy

## Installing tapipy

Before you install: Low install friction with a pure-wheel distribution. Actively maintained with recent commits and no known vulnerabilities. Depends on 14 runtime packages including openapi_core and requests, all standard and well-maintained libraries.

License in practice: Licensed under BSD-4-Clause with permissive treatment, allowing commercial and private use with minimal restrictions.

Quickstart:

pip install tapipy

from tapipy.tapis import Tapis

t = Tapis(base_url='https://tacc.tapis.io', username='user', password='pass')
t.get_tokens()
result = t.sk.hasRole(tenant='dev', user='testuser', roleName='admin')

Requires network access to a running Tapis instance and valid tenant credentials; OpenAPI spec files are downloaded and cached at initialization.

Verify before relying:

- Whether spec caching behavior and cache invalidation strategy are suitable for production use cases with frequently-updated service definitions.
- Performance characteristics when working with large numbers of Tapis service endpoints or complex nested API calls.

## Package facts

- License: BSD-4-Clause (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 83.6K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

tapis api client python, openapi sdk generator, rest api python binding, tapis framework sdk, automated api client, openapi spec to python, api authentication wrapper, rest-api-client, openapi-sdk, tapis-framework

[View on SkillFed](https://skillfed.io/packages/tapipy) · [View on PyPI](https://pypi.org/project/tapipy/)