• TODO: Badges

The pybeamer library provides a simple way to interact with codeBeamer's REST API using Python. It is based on codeBeamer's swagger v3 version of the API.

From PyPi

• Need to figure this out

From Source

• Git clone repository
• Use pip install -r requirements.txt to install the required packages

More examples to come in the future.

But here's a short example of how to edit a tracker item's summary

from pybeamer import Codebeamer

codebeamer = Codebeamer(
	url = 'http://localhost',
	username='user',
	password='pass'
)

item = codebeamer.get_item(123)
summary = item.get_field('Summary')
summary.value = 'New Summary'

The entire codeBeamer space is able to be looked through if an item, tracker, or project is not known by name or ID.

from pybeamer import Codebeamer

codebeamer = Codebeamer(
	url = 'http://localhost',
	username='user',
	password='pass'
)

projects = codebeamer.get_projects()
trackers = projects[0].get_trackers()
items = trackers[0].get_items()

The library supports pagination through the API, but by default greedily fetch everything unless a page is specified. By default the page_size parameter on all functions that support it is 25 and the codeBeamer API supports any value between 1 and 500. The library will clamp the value passed to these functions.

from pybeamer import Codebeamer

codebeamer = Codebeamer(
	url = 'http://localhost',
	username='user',
	password='pass'
)

# only fetch 10 users
users = codebeamer.get_users(page=1, page_size=10) 
# fetch all users with minimal rest calls
users = codebeamer.get_users(page_size=500)

The library also employs a number of helpful features not present in the API, such as fetching projects and trackers by name or ID.

from pybeamer import Codebeamer

codebeamer = Codebeamer(
	url = 'http://localhost',
	username='user',
	password='pass'
)

project_by_id = codebeamer.get_project(1)
project_by_name = codebeamer.get_project('Project')

• POST /associations
• DELETE /associations/{associationId}
• GET /associations/{associationId}
• PUT /associations/{associationId}
• GET /associations/{associationId}/history
• GET /associations/types
• GET /associations/types/{associationTypeId}

• DELETE /attachments/{attachmentId}
• GET /attachments/{attachmentId}
• GET /attachments/{attachmentId}/content
• PUT /attachments/{attachmentId}/content
• GET /attachments/{attachmentId}/history
• PUT /attachments/{attachmentId}/restore

• POST /baselines

• GET /branches/{branchId}/item

• POST /deployment
• POST /deployment/export

• POST /export/items
• POST /export/tracker-item-reviews
• POST /projects/{projectId}/content

• DELETE /items/{itemId}/attachments
• GET /items/{itemId}/attachments
• POST /items/{itemId}/attachments
• DELETE /items/{itemId}/attachments/{attachmentId}
• GET /items/{itemId}/attachments/{attachmentId}
• GET /items/{itemId}/attachments/{attachmentId}/content
• PUT /items/{itemId}/attachments/{attachmentId}/content
• GET /items/{itemId}/attachments/content
• POST /items/attachments/content

• DELETE /items/{itemId}
• GET /items/{itemId}
  • Codebeamer.get_tracker_item()
  • Codebeamer.get_item()
• PUT /items/{itemId}
• GET /items/{itemId}/children
  • TrackerItem.get_children()
  • TrackerItem.children
• PATCH /items/{itemId}/children
• POST /items/{itemId}/children
• PUT /items/{itemId}/children
• GET /items/{itemId}/fields
  • TrackerItem.get_fields()
  • TrackerItem.get_field()
• PUT /items/{itemId}/fields
  • Field.value = 'val'
• GET /items/{itemId}/fields/{fieldId}/options
  • ChoiceField.get_options()
• GET /items/{itemId}/fields/accessibility
• PUT /items/{itemId}/fields/tables/{tableFieldId}
• GET /items/{itemId}/history
• DELETE /items/{itemId}/lock
• GET /items/{itemId}/lock
• PUT /items/{itemId}/lock
• GET /items/{itemId}/relations
• GET /items/{itemId}/reviews
• GET /items/{itemId}/transitions
• PUT /items/fields
• GET /items/query
• POST /items/query
• POST /items/relations
• GET /trackers/{trackerId}/children
• PATCH /trackers/{trackerId}/children
• POST /trackers/{trackerId}/children
• PUT /trackers/{trackerId}/children
• POST /trackers/{trackerId}/items

• DELETE /items/{itemId}/comments
• GET /items/{itemId}/comments
• POST /items/{itemId}/comments
• DELETE /items/{itemId}/comments/{commentId}
• GET /items/{itemId}/comments/{commentId}
• POST /items/{itemId}/comments/{commentId}
• PUT /items/{itemId}/comments/{commentId}

• GET /job/{jobId}
• POST /jobs/working-set-update

• POST /migration/attachment

• GET /projects
  • Codebeamer.get_projects()
• GET /projects/{projectId}
  • Codebeamer.get_project()
• GET /projects/{projectId}/members
• GET /projects/{projectId}/members/{userId}/permissions
• GET /projects/{projectId}/trackers
  • Project.get_trackers()
  • Project.get_tracker()
• POST /projects/{projectId}/trackers
• POST /projects/{projectId}/trackers/search
• GET /projects/{projectId}/wikipages
• POST /projects/deploy
• POST /projects/search
  • Codebeamer.get_project_by_key() which is all this endpoint does

• POST /projects/{projectId}/wiki2html
• POST /wikipages
• PUT /wikipages/{itemId}
• DELETE /wikipages/{wikiId}
• GET /wikipages/{wikiId}
• GET /wikipages/{wikiId}/history
• GET /wikipages/{wikiId}/html
• DELETE /wikipages/{wikiId}/lock
• GET /wikipages/{wikiId}/lock
• PUT /wikipages/{wikiId}/lock
• GET /wikipages/{wikiId}/permissions
• PUT /wikipages/{wikiId}/permissions
• PUT /wikipages/{wikiId}/restorecontent

• POST /reports
• PUT /reports/{reportId}
• GET /reports/{reportId}/items
• GET /reports/{reportId}/results

• GET /roles
• GET /roles/{roleId}

• GET /system/maintenance
• PUT /system/maintenance

• POST /testcases/autoApplyStepReuses

• PUT /testruns/{testRunId}
• POST /trackers/{testRunTrackerId}/automatedtestruns
• POST /trackers/{testRunTrackerId}/testruns
• POST /trackers/{testRunTrackerId}/testruns/generatefromtestset

• POST /traceability/items
• POST /traceability/relations

• GET /trackers/{trackerId}/permissions
• DELETE /trackers/{trackerId}/roles/{roleId}/permissions
• PUT /trackers/{trackerId}/roles/{roleId}/permissions
• GET /trackers/permissions
• GET /trackers/permissions/{trackerPermissionId}

• DELETE /trackers/{trackerId}
• GET /trackers/{trackerId}
  • Codebeamer.get_tracker()
  • Project.get_tracker()
• PUT /trackers/{trackerId}
• GET /trackers/{trackerId}/baselines
• GET /trackers/{trackerId}/fields
  • Tracker.get_fields()
• GET /trackers/{trackerId}/fields/{fieldId}
  • Tracker.get_field()
• GET /trackers/{trackerId}/fields/{fieldId}/options/{optionId}
• GET /trackers/{trackerId}/fields/{fieldId}/permissions
• GET /trackers/{trackerId}/fields/permissions
• PUT /trackers/{trackerId}/icon
• GET /trackers/{trackerId}/items
  • Tracker.get_tracker_items()
  • Tracker.get_items()
• GET /trackers/{trackerId}/outline
• GET /trackers/{trackerId}/schema
• GET /trackers/{trackerId}/transitions
• GET /trackers/types
• GET /trackers/types/{trackerTypeId}

• GET /trackers/{trackerId}/reports
• POST /trackers/{trackerId}/reports
• DELETE /trackers/{trackerId}/reports/{reportId}
• PUT /trackers/{trackerId}/reports/{reportId}
• GET /trackers/{trackerId}/reports/{reportId}/items
• GET /trackers/{trackerId}/reports/{reportId}/results

• GET /users
  • Codebeamer.get_users()
• GET /users/{userId}
  • Codebeamer.get_user()
• GET /users/findByEmail
  • Codebeamer.get_user()
• GET /users/findByName
  • Codebeamer.get_user()
• POST /users/search

• GET /users/groups
• GET /users/groups/{groupId}
• GET /users/groups/{groupId}/members

• GET /wikipages/{wikiId}/attachments
• POST /wikipages/{wikiId}/comments