Git Data services¶
Example:
from pygithub3 import Github
gh = Github(user='someone', repo='some_repo')
a_blob = gh.git_data.blobs.get('a long sha')
dev_branch = gh.git_data.references.get('heads/add_a_thing')
GitData¶
Blobs¶
-
class
pygithub3.services.git_data.
Blobs
(**config)¶ Consume Blobs API
-
create
(data, user=None, repo=None)¶ Create a blob
Parameters: - data (dict) – Data describing the blob to create
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(sha, user=None, repo=None)¶ Get a particular blob
Parameters: - sha (str) – The sha of the blob to get
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
Commits¶
-
class
pygithub3.services.git_data.
Commits
(**config)¶ Consume Commits API
-
create
(data, user=None, repo=None)¶ create a commit on a repo
Parameters: - data (dict) – Input. See github commits doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(sha, user=None, repo=None)¶ get a commit from the current repo
Parameters: - sha (str) – SHA of the Commit that you want
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
References¶
-
class
pygithub3.services.git_data.
References
(**config)¶ Consume References API
-
create
(data, user=None, repo=None)¶ Create a reference
Parameters: - data (dict) – Input. See github refs doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
delete
(ref, user=None, repo=None)¶ Delete a reference
Parameters: - ref (str) – The SHA of the reference to delete
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(ref, user=None, repo=None)¶ Get a reference
Parameters: - ref (str) – The name of the reference to get
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
Note
Remember that branch references look like “heads/<branch_name>”
-
list
(namespace='', user=None, repo=None)¶ List all the references
Parameters: - namespace (str) – Limit the request to a particular type of
reference. For example,
heads
ortags
. - user (str) – Username
- repo (str) – Repository
Returns: A Result
Note
Remember Config precedence
- namespace (str) – Limit the request to a particular type of
reference. For example,
-
update
(ref, data, user=None, repo=None)¶ Update an existing reference
Parameters: - ref (str) – The SHA of the reference to update
- data (dict) – Input. See github refs doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
Tags¶
-
class
pygithub3.services.git_data.
Tags
(**config)¶ Consume Tags API
-
create
(data, user=None, repo=None)¶ Create a tag
Parameters: - data (dict) – Input. See github tags doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(sha, user=None, repo=None)¶ Get a tag
Parameters: - sha (str) – The sha of the tag to get.
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
Trees¶
-
class
pygithub3.services.git_data.
Trees
(**config)¶ Consume Trees API
-
create
(data, user=None, repo=None)¶ Create a tree object
Parameters: - data (dict) – Input. See github trees doc
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-
get
(sha, recursive=False, user=None, repo=None)¶ Get a tree object
Parameters: - sha (str) – The SHA of the tree you want.
- recursive (bool) – Whether to resolve each sub-tree belonging to this tree
- user (str) – Username
- repo (str) – Repository
Note
Remember Config precedence
-