Git Repos

class Git_Repos(session_kwargs, client, return_type='raw')

Methods

`delete`(id)	Remove the bookmark on a git repository
`get`(id)	Get a bookmarked git repository
`list`(*[, limit, page_num, order, order_dir, ...])	List bookmarked git repositories
`list_refs`(id)	Get all branches and tags of a bookmarked git repository
`post`(repo_url)	Bookmark a git repository

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.git_repos.list(...)

delete(id: int) → Response

Remove the bookmark on a git repository

Parameters:

Returns:

get(id: int) → Response

Get a bookmarked git repository

Parameters:

Returns:

civis.Response

list(*, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List bookmarked git repositories

Parameters:

limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 100.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to repo_url. Must be one of: repo_url, created_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

list_refs(id: int) → Response

Get all branches and tags of a bookmarked git repository

Parameters:

Returns:

civis.Response

post(repo_url: str) → Response

Bookmark a git repository

Parameters:

Returns:

civis.Response