MCPcopy Index your code
hub / github.com/PyGithub/PyGithub / get_readme

Method get_readme

github/Repository.py:3511–3522  ·  view source on GitHub ↗

:calls: `GET /repos/{owner}/{repo}/readme `_ :param ref: string :rtype: :class:`github.ContentFile.ContentFile`

(self, ref: Opt[str] = NotSet)

Source from the content-addressed store, hash-verified

3509 )
3510
3511 def get_readme(self, ref: Opt[str] = NotSet) -> ContentFile:
3512 """
3513 :calls: `GET /repos/{owner}/{repo}/readme <https://docs.github.com/en/rest/reference/repos#contents>`_
3514 :param ref: string
3515 :rtype: :class:`github.ContentFile.ContentFile`
3516 """
3517 assert is_optional(ref, str), ref
3518 url_parameters = dict()
3519 if is_defined(ref):
3520 url_parameters["ref"] = ref
3521 headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/readme", parameters=url_parameters)
3522 return github.ContentFile.ContentFile(self._requester, headers, data, completed=True)
3523
3524 def get_self_hosted_runner(self, runner_id: int) -> SelfHostedActionsRunner:
3525 """

Callers 3

setUpMethod · 0.80
testGetContentsMethod · 0.80

Calls 3

is_optionalFunction · 0.90
is_definedFunction · 0.90
requestJsonAndCheckMethod · 0.80

Tested by

no test coverage detected