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)

Remove the bookmark on a git repository

Parameters:
idint

The ID for this git repository.

Returns:
None

Response code 204: success

get(id: int)

Get a bookmarked git repository

Parameters:
idint

The ID for this git repository.

Returns:
civis.response.Response
  • idint

    The ID for this git repository.

  • repo_urlstr

    The URL for this git repository.

  • created_at : str (time)

  • updated_at : str (time)

list(*, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None)

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 to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.

Returns:
civis.response.PaginatedResponse
  • idint

    The ID for this git repository.

  • repo_urlstr

    The URL for this git repository.

  • created_at : str (time)

  • updated_at : str (time)

list_refs(id: int)

Get all branches and tags of a bookmarked git repository

Parameters:
idint

The ID for this git repository.

Returns:
civis.response.Response
  • branchesList[str]

    List of branch names of this git repository.

  • tagsList[str]

    List of tag names of this git repository.

post(repo_url: str)

Bookmark a git repository

Parameters:
repo_urlstr

The URL for this git repository.

Returns:
civis.response.Response
  • idint

    The ID for this git repository.

  • repo_urlstr

    The URL for this git repository.

  • created_at : str (time)

  • updated_at : str (time)