circleclient package¶
Submodules¶
circleclient.circleclient module¶
- class circleclient.circleclient.Build(client)[source]¶
Bases: object
- artifacts(username, project, build_num)[source]¶
Return artifacts produced by given build.
Return information about artifacts as a list of dictionaries.
- recent(username, project, limit=1, offset=0, branch=None, status_filter='')[source]¶
Return status of recent builds for given project.
Retrieves build statuses for given project and branch. If branch is None it retrieves most recent build.
- Args:
username (str): Name of the user. project (str): Name of the project. limit (int): Number of builds to return, default=1, max=100. offset (int): Returns builds starting from given offset. branch (str): Optional branch name as string. If specified only
builds from given branch are returned.- status_filter (str): Restricts which builds are returned. Set to
- “completed”, “successful”, “failed”, “running”, or defaults to no filter.
- Returns:
- A list of dictionaries with information about each build.
- class circleclient.circleclient.CircleClient(api_token=None)[source]¶
Bases: object
Represents CircleCI client.
- Attributes:
- api_token: CircleCI API token for the client.