---
id: py-jama-rest-client
version: "1.17.1"
license: MIT
license_treatment: permissive
maintenance: dormant
---

# py-jama-rest-client — A client for the Jama Connect REST API

License: permissive · Maintenance: dormant · Downloads: 80.9K/mo

## What it is and what it does

py-jama-rest-client is a Python wrapper around the Jama Connect REST API, distributed by Jama Software as an example client. It abstracts HTTP operations into Python methods for common tasks: retrieving and modifying items, managing attachments, handling test cycles and runs, querying relationships, and managing users and projects within a Jama instance. The client supports both basic authentication and OAuth.

The package depends only on requests and installs with low friction. However, it is explicitly described as distributed "as-is as an example" and likely requires modification for specific use cases. Maintenance is dormant (last release June 2023), and the classifier targets only Python 3.7, raising questions about compatibility with current Python versions. It is best suited for teams already committed to Jama Connect who need programmatic access to their instance and can maintain or adapt the code as needed.

Use it for:

- Automate bulk retrieval or updates of requirements and test items from a Jama instance for reporting or integration.
- Sync project data between Jama Connect and external systems or databases.
- Build custom dashboards or tools that query Jama project metadata, relationships, and test results.
- Manage test cycles and runs programmatically as part of continuous integration workflows.
- Batch-upload attachments or create relationships between items without manual Jama UI interaction.

## Worth the install?

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

A Python REST API client for Jama Connect that retrieves and modifies requirements, test management, and project data within a Jama instance.

Yes, if you use Jama Connect and need programmatic API access—the client is straightforward and has low install friction. However, treat it as example code: verify compatibility with your Python version and Jama instance, expect to modify it for your use case, and be aware that maintenance is dormant. Not recommended for new projects seeking an actively maintained, production-grade integration library.

## Install

pip install py-jama-rest-client
uv add py-jama-rest-client
poetry add py-jama-rest-client

## Installing py-jama-rest-client

Before you install: Low install friction with a single dependency (requests). Maintenance is dormant: last release was 1150 days ago (June 2023), though the repository remains active with recent commits. The package is marked Beta and targets Python 3.7, which is outdated; compatibility with modern Python versions is unclear.

License in practice: MIT license is permissive and imposes no restrictions on use, modification, or distribution in commercial or private projects.

Quickstart:

from py_jama_rest_client.client import JamaClient

client = JamaClient('https://yourdomain.jamacloud.com', credentials=('username', 'password'))
projects = client.get_projects()

Requires a Jama Connect instance with network access; authentication credentials (username/password or OAuth client ID/secret) must be configured.

Verify before relying:

- Whether the package works with Python versions newer than 3.7 despite classifier targeting only 3.7.
- Current state of API compatibility with recent Jama Connect versions given the 1150-day gap since last release.
- Whether the package is suitable for production use or remains example/reference code as the description suggests.

## Package facts

- License: MIT (permissive)
- Python support: unspecified
- Install friction: low
- Maintenance: dormant
- Downloads: 80.9K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

jama connect api client, requirements management rest client, jama software integration, test management api python, jama instance data access, requirements traceability api, jama project management client, jama-connect, rest-api-client, requirements-management

[View on SkillFed](https://skillfed.io/packages/py-jama-rest-client) · [View on PyPI](https://pypi.org/project/py-jama-rest-client/)