_OgSrSSKrSSKrSSKrSSKrSSKJr SSKJr SSKJ r SSKJ r SSKJ r SS KJ r SS KJ r SS KJr SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSK Jr SSK Jr SSK Jr SSKJr SSKJr \R<"S5r"SS\R@5r!"SS\!5r"g)z4This module contains the main interfaces to the API.N)apps)auths) decorators)events)gists)issues)licenses)models) notifications)orgs)projects)pulls)searchsession)structs)users)utils)requires_app_credentials) requires_auth)requires_basic_auth) invitation)repoz6https?://[\w\d\-\.\:]+/\w[\w-]+\w/[\w\._-]+/events/\w+c ^\rSrSrSrSoU4SjjrSr\S5r\/4Sj5r SpSjr SqS jr SqS jr SqS jr S r\R S 5r\R SrSj5r\R S5r\R S5r\R S5r\R,SpSj5r\R S5r\S5r\SpSj5rSsSjr\SpS\S\R>\ S\RB\"RFSS44Sjj5r$\S\"RJS\&4Sj5r'\S\"RJS\&4Sj5r(\S\"RJS\&4Sj5r)Sr*\StS j5r+\S!5r,\SSS/S4S"j5r-\SuS#j5r.\SvS$j5r/\/4S%j5r0\SpS&j5r1S'r2\S(5r3\S)5r4SpS*jr5\SpS+j5r6SpS,jr7\SpS-j5r8S.r9\SpS/j5r:SpS0jr;S1r\SpS4j5r?\S55r@\S65rAS7rB\SwS8j5rCSxS9jrD\S:5rE\SpS;j5rFS<rGSpS=jrHSyS>jrI\JR4S?jrLSzS@jrMS{SAjrN\SB5rO\SC5rPSDrQ\S|SEj5rRS}SFjrSSGrT\SwSHj5rU\SpSIj5rVSpSJjrWSKrXSLrYSMrZS~SNjr[\SSOj5r\\SSPj5r]SQr^SRr_\SSSj5r`SSTjraSUrb\SpSVj5rcSWrd\eSX5rf\eSY5rgSSZjrhSS[jriSS\jrjSS]jrkSS^jrlS_rmS`rn\Sa5ro\SSbj5rpSScjrq\SpSdj5rrSpSejrs\Sf5rt\Sg5ru\SShj5rvSirw\SSjj5rx\SpSkj5rySlrzSmr{Snr|U=r}$)GitHub%aStores all the session information. There are two ways to log into the GitHub API .. code-block:: python from github3 import login g = login(user, password) g = login(token=token) g = login(user, token=token) or .. code-block:: python from github3 import GitHub g = GitHub(user, password) g = GitHub(token=token) g = GitHub(user, token=token) This is simple backward compatibility since originally there was no way to call the GitHub object with authentication parameters. Nc >[TU]0U=(d UR55 U(a'URRR SU05 U(aUR XS9 gU(aU(aUR X5 ggg)zCreate a new GitHub instance to talk to the API. :param str api_version: API version to send with X-GitHub-Api-Version header. See https://docs.github.com/en/rest/overview/api-versions for details about API versions. zX-GitHub-Api-Version)tokenN)super__init__ new_sessionrheadersupdatelogin)selfusernamepasswordrr api_version __class__s S/Users/admin/workspace/ai/Jarvis/env/lib/python3.13/site-packages/github3/github.pyr!GitHub.__init__>sl W:(8(8(:;  LL ' ')?(M N  JJxJ - ( JJx *#XcURR(aSURR<S3$S[U5SS3$)Nz z)rauthidr&s r+_repr GitHub._reprRs> <<  t||00326 6(D! A66r-c[USU5nURSSSU5nSS0nURURU[R "U5S9S5nUR [RU5$) aCActivate the membership to an organization. :param organization: the organization or organization login for which to activate the membership :type organization: str :type organization: :class:`~github3.orgs.Organization` :returns: the activated membership :rtype: :class:`~github3.orgs.Membership` r%user membershipsr stateactivedata) getattr _build_url_json_patchjsondumps_instance_or_nullr Membership)r& organizationorganization_nameurlr=rAs r+activate_membershipGitHub.activate_membershipWst $L'<Hoo M6+< " 4;;sD1A;BCH%%doou==r-c/nU(a1URSS5nURURX1S9S5nU(a'UVs/sHn[R"X@5PM sn$/$s snf)zAdd the addresses to the authenticated user's account. :param list addresses: (optional), email addresses to be added :returns: list of email objects :rtype: [:class:`~github3.users.Email`] r8emailsr<)r@rA_postrEmail)r& addressesrCrIemails r+add_email_addressesGitHub.add_email_addressesos_ //&(3C::djjj=sCD?Cd;dU E(d;KK;s A+cvURS5nUR[U5U[RUS9$)a)Iterate over public events. :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of events :rtype: :class:`~github3.events.Event` retag)r@_iterintrEventr&numberrWrIs r+ all_eventsGitHub.all_eventss1ooh'zz#f+sFLLtzDDr-c|URS5nUR[U5U[RX$S.US9$)aIterate over every organization in the order they were created. :param int number: (optional), number of organizations to return. Default: -1, returns all of them :param int since: (optional), last organization id seen (allows restarting an iteration) :param str etag: (optional), ETag from a previous request to the same endpoint :param int per_page: (optional), number of organizations to list per request :returns: generator of organizations :rtype: :class:`~github3.orgs.ShortOrganization` organizationssinceper_pageparamsrWr@rXrYr ShortOrganizationr&r\rbrWrcrIs r+all_organizationsGitHub.all_organizationssD(ooo.zz K   " ""9   r-c|URS5nUR[U5U[RX$S.US9$)a Iterate over every repository in the order they were created. :param int number: (optional), number of repositories to return. Default: -1, returns all of them :param int since: (optional), last repository id seen (allows restarting an iteration) :param str etag: (optional), ETag from a previous request to the same endpoint :param int per_page: (optional), number of repositories to list per request :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository` repositoriesrardr@rXrYrShortRepositoryrhs r+all_repositoriesGitHub.all_repositoriessD(oon-zz K   "9   r-c |URS5nUR[U5U[RUX4S.S9$)a8Iterate over every user in the order they signed up for GitHub. .. versionchanged:: 1.0.0 Inserted the ``since`` parameter after the ``number`` parameter. :param int number: (optional), number of users to return. Default: -1, returns all of them :param int since: (optional), ID of the last user that you've seen. :param str etag: (optional), ETag from a previous request to the same endpoint :param int per_page: (optional), number of users to list per request :returns: generator of users :rtype: :class:`~github3.users.ShortUser` r)rcrb)rWrer@rXrYr ShortUser)r&r\rWrcrbrIs r+ all_usersGitHub.all_userssB*oog&zz K  OO (9   r-c[RnURS[U55nUR UR X2S9S5nUR [RU5$)aRetrieve information about a specific app using its "slug". .. versionadded:: 1.2.0 .. seealso:: `Get a single GitHub App`_ API Documentation :param app_slug: The identifier for the specific slug, e.g., ``test-github3-py-apps``. :returns: The app if and only if it is public. :rtype: :class:`~github3.apps.App` .. _Get a single GitHub App: https://developer.github.com/v3/apps/#get-a-single-github-app rr#r>)rAPP_PREVIEW_HEADERSr@strrA_getrEApp)r&app_slugr#rIrCs r+app GitHub.appsU***oofc(m4zz$))C)93?%%dhh55r-cURSS[U55nURURU[R S9S5nUR [RU5$)aRetrieve a specific App installation by its ID. .. versionadded: 1.2.0 .. seealso:: `Get a single installation`_ API Documentation :param int installation_id: The ID of the specific installation. :returns: The installation. :rtype: :class:`~github3.apps.Installation` .. _Get a single installation: https://developer.github.com/v3/apps/#get-a-single-installation r} installationsrwr>)r@ryrArzrrxrE Installation)r&installation_idrIrCs r+app_installationGitHub.app_installations\*ooe_c/6JKzz IIc4#;#;I >r-cURSS5nUR[U5U[R[R S9$)a[Retrieve the list of installations for the authenticated app. .. versionadded:: 1.2.0 .. seealso:: `Find installations`_ API Documentation :returns: The installations of the authenticated App. :rtype: :class:`~github3.apps.Installation` .. _Find installations: https://developer.github.com/v3/apps/#find-installations r}rrw)r@rXrYrrrx)r&r\rIs r+app_installationsGitHub.app_installationssF&ooe_5zz K    ,,   r-cURSUS5nURURU[RS9S5nUR [R U5$)aRetrieve an App installation for a specific organization. .. versionadded:: 1.2.0 .. seealso:: `Find organization installation`_ API Documentation :param str organization: The name of the organization. :returns: The installation :rtype: :class:`~github3.apps.Installation` .. _Find organization installation: https://developer.github.com/v3/apps/#find-organization-installation r installationrwr>)r@rArzrrxrEr)r&rGrIrCs r+!app_installation_for_organization(GitHub.app_installation_for_organization8sW*ooflNCzz IIc4#;#;I >r-c [US[U55n[USU5nURSXS5nURUR U[ R S9S5nUR[ RU5$)aRetrieve an App installation for a specific repository. .. versionadded:: 1.2.0 .. seealso:: `Find repository installation`_ API Documentation :param str owner: The name of the owner. :param str repostory: The name of the repository. :returns: The installation :rtype: :class:`~github3.apps.Installation` .. _Find repository installation: https://developer.github.com/v3/apps/#find-repository-installation r%namereposrrwr> r?ryr@rArzrrxrEr)r&owner repositoryrIrCs r+app_installation_for_repository&GitHub.app_installation_for_repositorySsw.wE 3Z< oogu.Izz IIc4#;#;I >r-c[US[U55nURSUS5nURUR U[ R S9S5nUR[ RU5$)aqRetrieve an App installation for a specific repository. .. versionadded:: 1.2.0 .. seealso:: `Find user installation`_ API Documentation :param str user: The name of the user. :returns: The installation :rtype: :class:`~github3.apps.Installation` .. _Find user installation: https://developer.github.com/v3/apps/#find-user-installation r%rrrwr>r)r&r8rIrCs r+app_installation_for_user GitHub.app_installation_for_userrsi*tWc$i0oogt^<zz IIc4#;#;I >r-c |URSS5nUR[U5U[RSUSS9$)aRetrieve repositories accessible by app installation. .. versionadded:: 3.2.1 .. seealso:: `List repositories accessible to the app installation`_ API Documentation :returns: The repositories accessible to the app installation :rtype: :class:`~github3.repos.repo.ShortRepository` .. _List repositories accessible to the app installation: https://docs.github.com/en/rest/apps/installations#list-repositories-accessible-to-the-app-installation rrlN)countrIclsrerWlist_keyrmr[s r+app_installation_reposGitHub.app_installation_repossF&oonn=zzf+$$#   r-c[RnURURUR S5US9S5nUR [R U5$)a]Retrieve information about the current app. .. versionadded:: 1.2.0 .. seealso:: `Get the authenticated GitHub App`_ API Documentation :returns: Metadata about the application :rtype: :class:`~github3.apps.App` .. _Get the authenticated GitHub App: https://developer.github.com/v3/apps/#get-the-authenticated-github-app r}rwr>)rrxrArzr@rEr{)r&r#rCs r+authenticated_appGitHub.authenticated_appsQ&**zz IIdooe,gI > %%dhh55r-cSn[U5S:a<URS[U55nURUR U5S5nUR [ RU5$)zGet information about authorization ``id``. :param int id_num: (required), unique id of the authorization :returns: :class:`~github3.auths.Authorization` Nrauthorizationsr>)rYr@ryrArzrEr Authorizationr&id_numrCrIs r+ authorizationGitHub.authorizationsZ v;?//"2CK@C::diinc2D%%e&9&94@@r-cvURS5nUR[U5U[RUS9$)aIterate over authorizations for the authenticated user. .. note:: This will return a 404 if you are using a token for authentication. :param int number: (optional), number of authorizations to return. Default: -1 returns all available authorizations :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of authorizations :rtype: :class:`~github3.auths.Authorization` rrV)r@rXrYrrr[s r+rGitHub.authorizationss4&oo./zz#f+sE,?,?dzKKr-cPSnU(amU(afURS5n UUUUS.n U(aX:S'URRX5 URUR XS9S5nSSS5 UR [ RU5$!,(df  N.=f)aObtain an authorization token. The retrieved token will allow future consumers to use the API without a username and password. :param str username: (required) :param str password: (required) :param list scopes: (optional), areas you want this token to apply to, i.e., 'gist', 'user' :param str note: (optional), note about the authorization :param str note_url: (optional), url for the application :param str client_id: (optional), 20 character OAuth client key for which to create a token :param str client_secret: (optional), 40 character OAuth client secret for which to create the token :returns: created authorization :rtype: :class:`~github3.auths.Authorization` Nr)notenote_url client_id client_secretscopesr<rN)r@rtemporary_basic_authrArOrErr) r&r'r(rrrrrrCrIr=s r+ authorizeGitHub.authorizesJ //"23C$&!. D !'X228Fzz$**S*"}}TYYs^S#66r-c~URSS[U55nURURU5SS5$)zUnblock a specific user from an organization. .. versionadded:: 2.1.0 :parameter str username: Name (or user-like instance) of the user to unblock. :returns: True if successful, Fales otherwise :rtype: bool r8rrr)r@ryr_deleters r+unblockGitHub.unblockEs6oofhH >}}T\\#.S99r-c~URSS[U55nURURU5SS5$)zCheck if this organization is blocking a specific user. .. versionadded:: 2.1.0 :parameter str username: Name (or user-like instance) of the user to unblock. :returns: True if successful, Fales otherwise :rtype: bool r8rrr)r@ryrrzrs r+ is_blockingGitHub.is_blockingUrr-c0URRnURS5URS54nU(aWU(aPURS[ US5S[ U55nUR UUSSS.S9nUR US S 5$g ) aUCheck an authorization created by a registered application. OAuth applications can use this method to check token validity without hitting normal rate limits because of failed login attempts. If the token is valid, it will return True, otherwise it will return False. :returns: True if token is valid, False otherwise :rtype: bool rr applicationsrtokensNrr)r2rer>rF)rregetr@ryrzr)r& access_tokenpr2rIresps r+check_authorizationGitHub.check_authorizationes LL  k"AEE/$:; D//DG hL8IC99%)DAD ==sC0 0r-cUUUS.nURS5nURURXTS9S5nUR[R U5$)aCreate a new gist. .. versionchanged:: 1.1.0 Per `GitHub's recent announcement`_ authentication is now required for creating gists. .. _GitHub's recent announcement: https://blog.github.com/2018-02-18-deprecation-notice-removing-anonymous-gist-creation/ :param str description: (required), description of gist :param dict files: (required), file names with associated dictionaries for content, e.g. ``{'spam.txt': {'content': 'File contents ...'}}`` :param bool public: (optional), make the gist public if True :returns: the created gist if successful, otherwise ``None`` :rtype: created gist :rtype: :class:`~github3.gists.gist.Gist` ) descriptionpublicfilesrr<rN)r@rArOrErGist)r&rrrnew_gistrIrCs r+ create_gistGitHub.create_gistsV6'  oog&zz$**S*8#>%%ejj$77r-cURSS5nSU0nURURX#S9S5nUR[R U5$)zCreate a new GPG key. .. versionadded:: 1.2.0 :param str armored_public_key: (required), your GPG key, generated in ASCII-armored format :returns: the created GPG key if successful, otherwise ``None`` :rtype: :class:`~github3.users.GPGKey` r8gpg_keysarmored_public_keyr<rN)r@rArOrErGPGKey)r&rrIr=rCs r+create_gpg_keyGitHub.create_gpg_keysQoofj1$&89zz$**S*4c:%%ellD99r-c Sn U(aU(aU(aURX5n U bU R"X4XVXx5$UR[RS5$)aCreate an issue on the repository. .. note:: ``body``, ``assignee``, ``assignees``, ``milestone``, ``labels`` are all optional. .. warning:: This method retrieves the repository first and then uses it to create an issue. If you're making several issues, you should use :py:meth:`repository ` and then use :py:meth:`create_issue ` :param str owner: (required), login of the owner :param str repository: (required), repository name :param str title: (required), Title of issue to be created :param str body: (optional), The text of the issue, markdown formatted :param str assignee: (optional), Login of person to assign the issue to :param assignees: (optional), logins of the users to assign the issue to :param int milestone: (optional), id number of the milestone to attribute this issue to (e.g. if ``m`` is a :class:`~github3.issues.Milestone` object, ``m.number`` is what you pass here.) :param list labels: (optional), List of label names. :returns: created issue :rtype: :class:`~github3.issues.ShortIssue` N)r create_issuerEr ShortIssue) r&rrtitlebodyassignee milestonelabels assigneesrs r+rGitHub.create_issuesZd ZE??55D  $$X& %%f&7&7>>r-cSnU(a?U(a8XUS.nURSS5nURXeS9nURUS5nUR[R U5$)a\Create a new key for the authenticated user. :param str title: (required), key title :param str key: (required), actual key contents, accepts path as a string or file-like object :param bool read_only: (optional), restrict key access to read-only, default to False :returns: created key :rtype: :class:`~github3.users.Key` N)rkey read_onlyr8keysr<rN)r@rOrArErKey)r&rrrrCr=rIreqs r+ create_keyGitHub.create_keys_  S"YGD//&&1C**S*,C::c3'D%%eii66r-c URSS5n UUUUUUUUU S. n URURXS9S5n UR[R U 5$)aCreate a repository for the authenticated user. :param str name: (required), name of the repository .. warning: this be no longer than 100 characters :param str description: (optional) :param str homepage: (optional) :param str private: (optional), If ``True``, create a private repository. API default: ``False`` :param bool has_issues: (optional), If ``True``, enable issues for this repository. API default: ``True`` :param bool has_wiki: (optional), If ``True``, enable the wiki for this repository. API default: ``True`` :param bool auto_init: (optional), auto initialize the repository :param str gitignore_template: (optional), name of the git template to use; ignored if auto_init = False. :param bool has_projects: (optional), If ``True``, enable projects for this repository. API default: ``True`` :returns: created repository :rtype: :class:`~github3.repos.repo.Repository` r8r) rrhomepageprivate has_issueshas_wiki auto_initgitignore_template has_projectsr<rN)r@rArOrEr Repository) r&rrrrrrrrrrIr=rCs r+create_repositoryGitHub.create_repository skZoofg.& $ ""4(  zz$**S*4c:%%doot<Finclude_cache_infor@rArzr&rIs r+r GitHub.emojishs/ooh'zz$))C.#%zHHr-cLSnURS5nURURU5SSS9nUcg0nUR"S05n0nUR 5H@upx[ U[ 5(aUV s/sH o"U 5PM sn Xg'M6U"U5Xg'MB XdS'UR"5H]upx[ U[ 5(a+UV s/sHn [R"U 5PM sn XG'ME[R"U5XG'M_ U$s sn fs sn f)z{List GitHub's timeline resources in Atom format. :returns: dictionary parsed to include URITemplates :rtype: dict cU(dU$0nURSS5nURU5 Ub[R"U5US'U$)Nhref)popr$ uritemplate URITemplate) feed_dictret_dictr s r+ replace_href"GitHub.feeds..replace_hrefsL  H==.D OOI &#.#:#:4#@ Or-feedsr>FrN_links) r@rArzr items isinstancelistr r ) r&rrIrCr old_linksrrvaluedvs r+r GitHub.feedsys oog&zz$))C.#%zH <HHXr* $//+JC%&&9>>1|A> +51 ,!h**,JC%&&BGH%Qk55a8%H (44U; ' ?Is >D D!cSnU(a5URSSU5nURURU5SS5nU$)zMake the authenticated user follow the provided username. :param str username: (required), user to follow :returns: True if successful, False otherwise :rtype: bool Fr8 followingrrr@rrr&r'rrIs r+follow GitHub.follows= //&+x@C==3c:D r-czURSUS5nUR[U5U[RUS9$)aIterate over users being followed by ``username``. .. versionadded:: 1.0.0 This replaces iter_following('sigmavirus24'). :param str username: (required), login of the user to check :param int number: (optional), number of people to return. Default: -1 returns all people you follow :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of users :rtype: :class:`~github3.users.ShortUser` rrrVrrr&r'r\rWrIs r+ followed_byGitHub.followed_by5&oogx=zz#f+sEOO$zGGr-cxURSS5nUR[U5U[RUS9$)aIterate over followers of the authenticated user. .. versionadded:: 1.0.0 This replaces iter_followers(). :param int number: (optional), number of followers to return. Default: -1 returns all followers :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of followers :rtype: :class:`~github3.users.ShortUser` r8 followersrVrrr[s r+r(GitHub.followers3$oofk2zz#f+sEOO$zGGr-czURSUS5nUR[U5U[RUS9$)aIterate over followers of ``username``. .. versionadded:: 1.0.0 This replaces iter_followers('sigmavirus24'). :param str username: (required), login of the user to check :param int number: (optional), number of followers to return. Default: -1 returns all followers :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of followers :rtype: :class:`~github3.users.ShortUser` rr(rVrrr#s r+ followers_ofGitHub.followers_ofr&r-cxURSS5nUR[U5U[RUS9$)aIterate over users the authenticated user is following. .. versionadded:: 1.0.0 This replaces iter_following(). :param int number: (optional), number of people to return. Default: -1 returns all people you follow :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of users :rtype: :class:`~github3.users.ShortUser` r8rrVrrr[s r+rGitHub.followingr*r-cURS[U55nURURU5S5nUR [ R U5$)zRetrieve the gist using the specified id number. :param int id_num: (required), unique id of the gist :returns: the gist identified by ``id_num`` :rtype: :class:`~github3.gists.gist.Gist` rr>)r@ryrArzrErrr&rrIrCs r+gist GitHub.gistsGoogs6{3zz$))C.#.%%ejj$77r-cvURS5nUR[U5U[RUS9$)aSRetrieve the authenticated user's gists. .. versionadded:: 1.0 :param int number: (optional), number of gists to return. Default: -1, returns all available gists :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of short gists :rtype: :class:~github3.gists.ShortGist` rrVr@rXrYr ShortGistr[s r+r GitHub.gists(s1 oog&zz#f+sEOO$zGGr-czURSUS5nUR[U5U[RUS9$)aIterate over the gists owned by a user. .. versionadded:: 1.0 :param str username: login of the user who owns the gists :param int number: (optional), number of gists to return. Default: -1 returns all available gists :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of short gists owned by the specified user :rtype: :class:`~github3.gists.ShortGist` rrrVr5r#s r+gists_byGitHub.gists_by;s5"oogx9zz#f+sEOO$zGGr-cURSSU5nURURU5S5nU(dgUR"SS5$)zUReturn the template for language. :returns: the template string :rtype: str gitignore templatesr>source)r@rArzr)r&languagerIrCs r+rGitHub.gitignore_templateOsEook;Azz$))C.#.xx"%%r-czURSS5nURURU5S5=(d /$)z`Return the list of available templates. :returns: list of template names :rtype: [str] r<r=r>rrs r+gitignore_templatesGitHub.gitignore_templates]s2ook;7zz$))C.#.4"4r-cURSSU5nURURU5S5nUR[R U5$)zRetrieve the GPG key of the authenticated user specified by id_num. .. versionadded:: 1.2.0 :returns: the GPG key specified by id_num :rtype: :class:`~github3.users.GPGKey` r8rr>)r@rArzrErrr1s r+gpg_keyGitHub.gpg_keyhsEoofj&9zz$))C.#.%%ellD99r-cxURSS5nUR[U5U[RUS9$)aIterate over the GPG keys of the authenticated user. .. versionadded:: 1.2.0 :param int number: (optional), number of GPG keys to return. Default: -1 returns all available GPG keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of the GPG keys belonging to the authenticated user :rtype: :class:`~github3.users.GPGKey` r8rrV)r@rXrYrrr[s r+rGitHub.gpg_keysws3oofj1zz#f+sELLtzDDr-cSnU(a5URSSU5nURURU5SS5nU$)zCheck if the authenticated user is following login. :param str username: (required), login of the user to check if the authenticated user is checking :returns: True if following, False otherwise :rtype: bool Fr8rrrr@rrz)r&r'rCrIs r+ is_followingGitHub.is_followings= //&+x@C==3c:D r-cSnU(a<U(a5URSSX5nURURU5SS5nU$)zCheck if the authenticated user starred username/repo. :param str username: (required), owner of repository :param str repo: (required), name of repository :returns: True if starred, False otherwise :rtype: bool Fr8starredrrrK)r&r'rrCrIs r+ is_starredGitHub.is_starred? //&)XDC==3c:D r-c SnU(aTU(aM[U5S:a>URSXS[U55nURUR U5S5nUR [ RU5$)aFetch issue from owner/repository. :param str username: (required), owner of the repository :param str repository: (required), name of the repository :param int number: (required), issue number :return: the issue :rtype: :class:`~github3.issues.issue.Issue` Nrrr r>)rYr@ryrArzrEr Issue)r&r'rr\rCrIs r+issue GitHub.issuesd  s6{Q//xVC::diinc2D%%fllD99r-c URS5n [R"XX4XV5n UR[ U5U [R X5$)ayList all of the authenticated user's (and organization's) issues. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param str filter: accepted values: ('assigned', 'created', 'mentioned', 'subscribed') api-default: 'assigned' :param str state: accepted values: ('all', 'open', 'closed') api-default: 'open' :param str labels: comma-separated list of label names, e.g., 'bug,ui,@high' :param str sort: accepted values: ('created', 'updated', 'comments') api-default: created :param str direction: accepted values: ('asc', 'desc') api-default: desc :param since: (optional), Only issues after this date will be returned. This can be a `datetime` or an ISO8601 formatted date string, e.g., 2012-05-20T23:10:27Z :type since: :class:`~datetime.datetime` or str :param int number: (optional), number of issues to return. Default: -1 returns all issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of issues :rtype: :class:`~github3.issues.ShortIssue` r r@r issue_paramsrXrYr) r&filterr:rsort directionrbr\rWrIres r+r GitHub.issuessKdooh'$$ 6 zz#f+sF,=,=vLLr-c U(a`U(aYURSXS5n [R"UUUUUUU U 5nUR[ U 5U [ R XS9$[/5$)a List issues on owner/repository. Only owner and repository are required. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param str username: login of the owner of the repository :param str repository: name of the repository :param int milestone: None, '*', or ID of milestone :param str state: accepted values: ('all', 'open', 'closed') api-default: 'open' :param str assignee: '*' or login of the user :param str mentioned: login of the user :param str labels: comma-separated list of label names, e.g., 'bug,ui,@high' :param str sort: accepted values: ('created', 'updated', 'comments') api-default: created :param str direction: accepted values: ('asc', 'desc') api-default: desc :param since: (optional), Only issues after this date will be returned. This can be a `datetime` or an ISO8601 formatted date string, e.g., 2012-05-20T23:10:27Z :type since: :class:`~datetime.datetime` or str :param int number: (optional), number of issues to return. Default: -1 returns all issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of issues :rtype: :class:`~github3.issues.ShortIssue` rr rd)r@rrepo_issue_paramsrXrYr riter)r&r'rrr:r mentionedrr[r\rbr\rWrIres r+ issues_onGitHub.issues_onszz  //'8JC++ F::F S&"3"3F Bxr-cSn[U5S:a=URSS[U55nURUR U5S5nUR [ RU5$)zGet the authenticated user's key specified by id_num. :param int id_num: (required), unique id of the key :returns: created key :rtype: :class:`~github3.users.Key` Nrr8rr>)rYr@ryrArzrErrrs r+r GitHub.keyLsY v;?//&&#f+>C::diinc2D%%eii66r-cxURSS5nUR[U5U[RUS9$)a4Iterate over public keys for the authenticated user. :param int number: (optional), number of keys to return. Default: -1 returns all your keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of keys :rtype: :class:`~github3.users.Key` r8rrV)r@rXrYrrr[s r+r GitHub.keys]s3ooff-zz#f+sEIIDzAAr-cURSU5nURURU5S5nUR[R U5$)zRetrieve the license specified by the name. :param string name: (required), name of license :returns: the specified license :rtype: :class:`~github3.licenses.License` r r>)r@rArzrEr License)r&rrIrCs r+licenseGitHub.licensensEooj$/zz$))C.#.%%h&6&6==r-cvURS5nUR[U5U[RUS9$)zIterate over open source licenses. :returns: generator of short license objects :rtype: :class:`~github3.licenses.ShortLicense` r rV)r@rXrYr ShortLicenser[s r+r GitHub.licenses|s3ooj)zz#f+sH,A,AzMMr-cU(a#U(aURRX5 O"U(aURRU5 URRU5 g)a<Log the user into GitHub for protected API calls. :param str username: login name :param str password: password for the login :param str token: OAuth token :param func two_factor_callback: (optional), function you implement to provide the Two-factor Authentication code to GitHub when necessary N)r basic_auth token_authtwo_factor_auth_callback)r&r'r(rtwo_factor_callbacks r+r% GitHub.loginsE&  LL # #H 7  LL # #E * --.ABr-ch[R"XU5nURRXC5 g)acLogin as a GitHub Application. .. versionadded:: 1.2.0 .. seealso:: `Authenticating as an App`_ GitHub's documentation of authenticating as an application. :param bytes private_key_pem: The bytes of the private key for this GitHub Application. :param int app_id: The integer identifier for this GitHub Application. :param int expire_in: The length in seconds for this token to be valid for. Default: 600 seconds (10 minutes) .. _Authenticating as an App: https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app N)r create_tokenrapp_bearer_token_auth)r&private_key_pemapp_id expire_inrs r+ login_as_appGitHub.login_as_apps(4!!/9E **5r=rCr#)r@rOokr) r&rrrrr=rCr#rIhtmlrs r+rGitHub.markdowns" //*e4CD&2GN #//*-CD#V **#V ")YD **S$*HCvvxx r-cURS5nURURU5S5nUR[R U5$)zRetrieve the info for the authenticated user. .. versionadded:: 1.0 This was separated from the ``user`` method. :returns: the representation of the authenticated user. :rtype: :class:`~github3.users.AuthenticatedUser` r8r>)r@rArzrErAuthenticatedUser)r&rIrCs r+me GitHub.me(sCoof%zz$))C.#.%%e&=&=tDDr-c[USU5nURSSSU5nURURU5S5nUR [ R U5$)a]Retrieve the user's membership in the specified organization. :param organization: the organization or organization login to retrieve the authorized user's membership in :type organization: str :type organization: :class:`~github3.orgs.Organization` :returns: the user's membership :rtype: :class:`~github3.orgs.Membership` r%r8r9r r>)r?r@rArzrEr rF)r&rGrHrIrCs r+ membership_inGitHub.membership_in9s\ $L'<Hoo M6+< zz$))C.#.%%doot<rrs r+r GitHub.metaPs0oof%zz$))C.#.4"4r-cSnUSLaSS0nO USLaSS0nURS5nUR[U5U[RXTS9$)aIterate over the user's notification. :param bool all: (optional), iterate over all notifications :param bool participating: (optional), only iterate over notifications in which the user is participating :param int number: (optional), how many notifications to return :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of threads :rtype: :class:`~github3.notifications.Thread` NTalltrue participatingr rV)r@rXrYr Thread)r&rrr\rWrerIs r+r GitHub.notifications`sb( $;V_F d "%v.Fooo.zz Km22F  r-cURS5nURUSU0S9nUR(a UR$S$)zReturn an easter egg of the API. :params str say: (optional), pass in what you'd like Octocat to say :returns: ascii art of Octocat :rtype: str octocatsrer>)r@rzrr)r&sayrIrs r+rGitHub.octocats=ooi(iiS#Ji/66sxx)r)r-cURSU5nURURU5S5nUR[R U5$)zReturn an Organization object for the login name. :param str username: (required), login name of the org :returns: the organization :rtype: :class:`~github3.orgs.Organization` r r>)r@rArzrEr Organizationr&r'rIrCs r+rGGitHub.organizationsEoofh/zz$))C.#.%%d&7&7>>r-c URSUS5n [R"X#XEXg5n UR[ U5U [R X5$)atIterate over the organization's issues. .. note:: This only works if the authenticated user belongs to it. :param str name: (required), name of the organization :param str filter: accepted values: ('assigned', 'created', 'mentioned', 'subscribed') api-default: 'assigned' :param str state: accepted values: ('open', 'closed') api-default: 'open' :param str labels: comma-separated list of label names, e.g., 'bug,ui,@high' :param str sort: accepted values: ('created', 'updated', 'comments') api-default: created :param str direction: accepted values: ('asc', 'desc') api-default: desc :param since: (optional), Only issues after this date will be returned. This can be a `datetime` or an ISO8601 formatted date string, e.g., 2012-05-20T23:10:27Z :type since: :class:`~datetime.datetime` or str :param int number: (optional), number of issues to return. Default: -1, returns all available issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of issues :rtype: :class:`~github3.issues.ShortIssue` r r rX) r&rrZr:rr[r\rbr\rWrIres r+organization_issuesGitHub.organization_issuessOjoofdH5$$ 6 zz#f+sF,=,=vLLr-cxURSS5nUR[U5U[RUS9$)aIterate over all organizations the authenticated user belongs to. This will display both the private memberships and the publicized memberships. :param int number: (optional), number of organizations to return. Default: -1 returns all available organizations :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of organizations :rtype: :class:`~github3.orgs.ShortOrganization` r8r rVrfr[s r+r`GitHub.organizationss5$ooff-zz#f+sD,B,BzNNr-cU(a<URSUS5nUR[U5U[RUS9$[ /5$)aIterate over organizations with ``username`` as a public member. .. versionadded:: 1.0.0 Replaces ``iter_orgs('sigmavirus24')``. :param str username: (optional), user whose orgs you wish to list :param int number: (optional), number of organizations to return. Default: -1 returns all available organizations :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of organizations :rtype: :class:`~github3.orgs.ShortOrganization` rr rV)r@rXrYr rgr`r#s r+organizations_withGitHub.organizations_withsM& //'8V) rYr@ryrArzrProjectCUSTOM_HEADERSrEr&r\rCrIs r+projectGitHub.projectstV A://*c&k:C:: #x'7'7'F'F GD%%h&6&6==r-c[U5nSnUS:aUURSSS[U55nURUR U[ R RS9S5nUR[ RU5$)zReturn the ProjectCard with id ``number``. :param int number: id of the project card :returns: :class:`~github3.projects.ProjectCard` Nrrcolumnscardsrwr>) rYr@ryrArzrrrrE ProjectCardrs r+ project_cardGitHub.project_cardsxV A://*i#f+NC:: #x'7'7'F'F GD%%h&:&:DAAr-c[U5nSnUS:aTURSS[U55nURUR U[ R RS9S5nUR[ RU5$)zReturn the ProjectColumn with id ``number``. :param int number: id of the project column :returns: :class:`~github3.projects.ProjectColumn` Nrrrrwr>) rYr@ryrArzrrrrE ProjectColumnrs r+project_columnGitHub.project_column*svV A://*iVEC:: #x'7'7'F'F GD%%h&<&URSXS[U55nURUR U5S5nUR [ RU5$)aFetch pull_request #:number: from :owner:/:repository. :param str owner: (required), owner of the repository :param str repository: (required), name of the repository :param int number: (required), issue number :return: :class:`~github.pulls.PullRequest` Nrrrr>)rYr@ryrArzrEr PullRequest)r&rrr\rCrIs r+ pull_requestGitHub.pull_requestsb v;?//GS[C::diinc2D%%e&7&7>>r-cfURS5nURURU5S5$)a~Return a dictionary with information from /rate_limit. The dictionary has two keys: ``resources`` and ``rate``. In ``resources`` you can access information about ``core`` or ``search``. Note: the ``rate`` key will be deprecated before version 3 of the GitHub API is finalized. Do not rely on that key. Instead, make your code future-proof by using ``core`` in ``resources``, e.g., .. code-block:: python rates = g.rate_limit() rates['resources']['core'] # => your normal ratelimit info rates['resources']['search'] # => your search ratelimit info .. versionadded:: 0.8 :returns: ratelimit mapping :rtype: dict rate_limitr>rrs r+rGitHub.rate_limits+.ool+zz$))C.#..r-cURSS5n0nUS;aURUS9 US;aURUS9 US;aURUS9 UR[U5U[R Xu5$) aYList repositories for the authenticated user filterable by ``type``. .. versionchanged:: 0.6 Removed the login parameter for correctness. Use repositories_by instead :param str type: (optional), accepted values: ('all', 'owner', 'public', 'private', 'member') API default: 'all' :param str sort: (optional), accepted values: ('created', 'updated', 'pushed', 'full_name') API default: 'created' :param str direction: (optional), accepted values: ('asc', 'desc'), API default: 'asc' when using 'full_name', 'desc' otherwise :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository` r8r)rrrrmembertypecreatedupdatedpushed full_namer[ascdescr\r@r$rXrYrrn)r&rr[r\r\rWrIres r+rlGitHub.repositoriessBoofg. B B MMtM $ @ @ MMtM $  ' MMIM .zz Kd22F  r-cURSUS5n0nUS;aURUS9 US;aURUS9 US;aURUS9 UR[U5U[R X5$) aList public repositories for the specified ``username``. .. versionadded:: 0.6 :param str username: (required), username :param str type: (optional), accepted values: ('all', 'owner', 'member') API default: 'all' :param str sort: (optional), accepted values: ('created', 'updated', 'pushed', 'full_name') API default: 'created' :param str direction: (optional), accepted values: ('asc', 'desc'), API default: 'asc' when using 'full_name', 'desc' otherwise :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository` rr)rrrrrrrrr) r&r'rr[r\r\rWrIres r+repositories_byGitHub.repositories_bysHoogx9 - - MMtM $ @ @ MMtM $  ' MMIM .zz Kd22F  r-cSnU(a:U(a3URSX5nURURU5S5nUR[R U5$)zRetrieve the desired repository. :param str owner: (required) :param str repository: (required) :returns: the repository :rtype: :class:`~github3.repos.repo.Repository` Nrr>)r@rArzrErr)r&rrrCrIs r+rGitHub.repository(sM Z//'5=C::diinc2D%%doot<?zz#f+sJ,A,AzMMr-c[U5nSnUS:a<URS[U55nURUR U5S5nUR [ RU5$)zRetrieve the repository with the globally unique id. :param int number: id of the repository :returns: the repository :rtype: :class:`~github3.repos.repo.Repository` Nrrlr>)rYr@ryrArzrErrrs r+repository_with_idGitHub.repository_with_idKs\V A://.#f+>C::diinc2D%%doot<2016-01-01``. - ``merge`` Matches merge commits when set to to ``true``, excludes them when set to ``false``. - ``hash`` Matches commits with the specified hash. Example: ``hash:124a9a0ee1d8f1e15e833aff432fbb3b02632105``. - ``parent`` Matches commits whose parent has the specified hash. Example: ``parent:124a9a0ee1d8f1e15e833aff432fbb3b02632105``. - ``tree`` Matches commits with the specified tree hash. Example: ``tree:99ca967``. - ``is`` Matches public repositories when set to ``public``, private repositories when set to ``private``. - ``user`` or ``org`` or ``repo`` Limits the search to a specific user, organization, or repository. For more information about these qualifiers, see: https://git.io/vb7XQ :param str query: (required), a valid query as described above, e.g., ``css repo:octocat/Spoon-Knife`` :param str sort: (optional), how the results should be sorted; options: ``author-date``, ``committer-date``; default: best match :param str order: (optional), the direction of the sorted results, options: ``asc``, ``desc``; default: ``desc`` :param int per_page: (optional) :param int number: (optional), number of commits to return. Default: -1, returns all available commits :param str etag: (optional), previous ETag header value :return: generator of commit search results :rtype: :class:`~github3.search.commits.CommitSearchResult` rr z$application/vnd.github.cloak-preview)z author-datezcommitter-dater[rrz, r rcommits)joinr@rr rCommitSearchResultrs r+search_commitsGitHub.search_commitssHuCD 4 4!6N E_,#7O  $ H%D!GH ooh 2%%    % %      r-c SU0n0n US;aX(S'US;aX8S'U(aSS0n URSS 5n [R"Xj[RXXy5$) u,Find issues by state and keyword. The query can contain any combination of the following supported qualifers: - ``type`` With this qualifier you can restrict the search to issues or pull request only. - ``in`` Qualifies which fields are searched. With this qualifier you can restrict the search to just the title, body, comments, or any combination of these. - ``author`` Finds issues created by a certain user. - ``assignee`` Finds issues that are assigned to a certain user. - ``mentions`` Finds issues that mention a certain user. - ``commenter`` Finds issues that a certain user commented on. - ``involves`` Finds issues that were either created by a certain user, assigned to that user, mention that user, or were commented on by that user. - ``state`` Filter issues based on whether they’re open or closed. - ``labels`` Filters issues based on their labels. - ``language`` Searches for issues within repositories that match a certain language. - ``created`` or ``updated`` Filters issues based on times of creation, or when they were last updated. - ``comments`` Filters issues based on the quantity of comments. - ``user`` or ``repo`` Limits searches to a specific user or repository. For more information about these qualifiers, see: http://git.io/d1oELA :param str query: (required), a valid query as described above, e.g., ``windows label:bug`` :param str sort: (optional), how the results should be sorted; options: ``created``, ``comments``, ``updated``; default: best match :param str order: (optional), the direction of the sorted results, options: ``asc``, ``desc``; default: ``desc`` :param int per_page: (optional) :param bool text_match: (optional), if True, return matching search terms. See http://git.io/QLQuSQ for more information :param int number: (optional), number of issues to return. Default: -1, returns all available issues :param str etag: (optional), previous ETag header value :return: generator of issue search results :rtype: :class:`~github3.search.issue.IssueSearchResult` r)commentsrrr[rrr r rr )r@rr rIssueSearchResultrs r+ search_issuesGitHub.search_issues5 sv@u 5 5!6N O ##7O JGooh1%% 114  r-c SU0n0n US;aX(S'US;aX8S'U(aSS0n URSS 5n [R"UU [RUUUU 5$) a;Find repositories via various criteria. The query can contain any combination of the following supported qualifers: - ``in`` Qualifies which fields are searched. With this qualifier you can restrict the search to just the repository name, description, readme, or any combination of these. - ``size`` Finds repositories that match a certain size (in kilobytes). - ``forks`` Filters repositories based on the number of forks, and/or whether forked repositories should be included in the results at all. - ``created`` or ``pushed`` Filters repositories based on times of creation, or when they were last updated. Format: ``YYYY-MM-DD``. Examples: ``created:<2011``, ``pushed:<2013-02``, ``pushed:>=2013-03-06`` - ``user`` or ``repo`` Limits searches to a specific user or repository. - ``language`` Searches repositories based on the language they're written in. - ``stars`` Searches repositories based on the number of stars. For more information about these qualifiers, see: http://git.io/4Z8AkA :param str query: (required), a valid query as described above, e.g., ``tetris language:assembly`` :param str sort: (optional), how the results should be sorted; options: ``stars``, ``forks``, ``updated``; default: best match :param str order: (optional), the direction of the sorted results, options: ``asc``, ``desc``; default: ``desc`` :param int per_page: (optional) :param bool text_match: (optional), if True, return matching search terms. See http://git.io/4ct1eQ for more information :param int number: (optional), number of repositories to return. Default: -1, returns all available repositories :param str etag: (optional), previous ETag header value :return: generator of repository search results :rtype: :class:`~github3.search.repository.RepositorySearchResult` r)starsforksrr[rrr r rrl)r@rr rRepositorySearchResultrs r+search_repositoriesGitHub.search_repositories svu 0 0!6N O ##7O JGooh7%%    ) )      r-c SU0n0n US;aX(S'US;aX8S'U(aSS0n URSS 5n [R"Xj[RXXy5$) aFind users via the Search API. The query can contain any combination of the following supported qualifers: - ``type`` With this qualifier you can restrict the search to just personal accounts or just organization accounts. - ``in`` Qualifies which fields are searched. With this qualifier you can restrict the search to just the username, public email, full name, or any combination of these. - ``repos`` Filters users based on the number of repositories they have. - ``location`` Filter users by the location indicated in their profile. - ``language`` Search for users that have repositories that match a certain language. - ``created`` Filter users based on when they joined. - ``followers`` Filter users based on the number of followers they have. For more information about these qualifiers see: http://git.io/wjVYJw :param str query: (required), a valid query as described above, e.g., ``tom repos:>42 followers:>1000`` :param str sort: (optional), how the results should be sorted; options: ``followers``, ``repositories``, or ``joined``; default: best match :param str order: (optional), the direction of the sorted results, options: ``asc``, ``desc``; default: ``desc`` :param int per_page: (optional) :param bool text_match: (optional), if True, return matching search terms. See http://git.io/_V1zRwa for more information :param int number: (optional), number of search results to return; Default: -1 returns all available :param str etag: (optional), ETag header value of the last request. :return: generator of user search results :rtype: :class:`~github3.search.user.UserSearchResult` r)r(rljoinedr[rrr r rr)r@rr rUserSearchResultrs r+ search_usersGitHub.search_users svtu : :!6N O ##7O JGooh0%% 00$  r-c*XS.URlg)zAllow the developer to set their OAuth application credentials. :param str id: 20-character hexidecimal client_id provided by GitHub :param str secret: 40-character hexidecimal client_secret provided by GitHub rN)rre)r&r3rs r+ set_client_idGitHub.set_client_id) s-/H r-cbU(dgURRRSU05 g)zAllow the user to set their own user agent string. :param str user_agent: string used to identify your application. Library default: "github3.py/{version}", e.g., "github3.py/1.0.0" Nz User-Agent)rr#r$)r& user_agents r+set_user_agentGitHub.set_user_agent3 s'  ##\:$>?r-cSnU(a<U(a5URSSX5nURURU5SS5nU$)zStar a repository. :param str username: (required), owner of the repo :param str repo: (required), name of the repo :return: True if successful, False otherwise :rtype: bool Fr8rOrrrr&r'rrrIs r+star GitHub.star> rRr-cXS.nURU5 URSS5nUR[U5U[R XT5$)aIterate over repositories starred by the authenticated user. .. versionchanged:: 1.0.0 This was split from ``iter_starred`` and requires authentication. :param str sort: (optional), either 'created' (when the star was created) or 'updated' (when the repository was last pushed to) :param str direction: (optional), either 'asc' or 'desc'. Default: 'desc' :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository>` r[r\r8rO) _remove_noner@rXrYrrn)r&r[r\r\rWrerIs r+rOGitHub.starredQ sN.7 &!oofi0zz Kd22F  r-cX#S.nURU5 URS[U5S5nUR[ U5U[ R Xe5$)aIterate over repositories starred by ``username``. .. versionadded:: 1.0 This was split from ``iter_starred`` and requires the login parameter. :param str username: name of user whose stars you want to see :param str sort: (optional), either 'created' (when the star was created) or 'updated' (when the repository was last pushed to) :param str direction: (optional), either 'asc' or 'desc'. Default: 'desc' :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository` r5rrO)r6r@ryrXrYrrn)r&r'r[r\r\rWrerIs r+ starred_byGitHub.starred_byo sT67 &!oogs8}i@zz Kd22F  r-cxURSS5nUR[U5U[RUS9$)afIterate over repositories subscribed to by the authenticated user. :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of repositories :rtype: :class:`~github3.repos.repo.ShortRepository` r8 subscriptionsrVrmr[s r+r<GitHub.subscriptions s5oofo6zz#f+sD,@,@tzLLr-cURS[U5S5nUR[U5U[R US9$)aIterate over repositories subscribed to by ``username``. :param str username: name of user whose subscriptions you want to see :param int number: (optional), number of repositories to return. Default: -1 returns all repositories :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of subscribed repositories :rtype: :class:`~github3.repos.repo.ShortRepository` rr<rV)r@ryrXrYrrnr#s r+subscriptions_forGitHub.subscriptions_for s;oogs8}oFzz#f+sD,@,@tzLLr-cSnU(a5URSSU5nURURU5SS5nU$)zMake the authenticated user stop following username. :param str username: (required) :returns: True if successful, False otherwise :rtype: bool Fr8rrrr@rrrs r+unfollowGitHub.unfollow s> //&+x@C==c!2C=D r-cSnU(a<U(a5URSSX5nURURU5SS5nU$)zUnstar username/repo. :param str username: (required), owner of the repo :param str repo: (required), name of the repo :return: True if successful, False otherwise :rtype: bool Fr8rOrrrBr1s r+unstar GitHub.unstar s@ //&)XDC==c!2C=D r-cUUUUUUUS.nURU5 URS5n URURU [R "U5S9S5n U (aUR U 5 gg)aUpdate the profile of the authenticated user. :param str name: e.g., 'John Smith', not login name :param str email: e.g., 'john.smith@example.com' :param str blog: e.g., 'http://www.example.com/jsmith/blog' :param str company: :param str location: :param bool hireable: defaults to False :param str bio: GitHub flavored markdown :returns: True if successful, False otherwise :rtype: bool )rrRblogcompanylocationhireablebior8r<r>TF)r6r@rArBrCrD_update_attributes) r&rrRrIrJrKrLrMr8rIrAs r+ update_meGitHub.update_me s{>    $oof% 4;;sD1A;BCH   # #E *r-cURSU5nURURU5S5nUR[R U5$)zRetrieve a User object for the specified user name. :param str username: name of the user :returns: the user :rtype: :class:`~github3.users.User` rr>)r@rArzrErUserrs r+r8 GitHub.user sCoogx0zz$))C.#.%%ejj$77r-c URSS5n [R"XX4XV5n U RUS9 UR [ U5U [R X5$)aList only the authenticated user's issues. Will not list organization's issues. See :meth:`organization_issues`. .. versionchanged:: 1.0 ``per_page`` parameter added before ``number`` .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param str filter: accepted values: ('assigned', 'created', 'mentioned', 'subscribed') api-default: 'assigned' :param str state: accepted values: ('all', 'open', 'closed') api-default: 'open' :param str labels: comma-separated list of label names, e.g., 'bug,ui,@high' :param str sort: accepted values: ('created', 'updated', 'comments') api-default: created :param str direction: accepted values: ('asc', 'desc') api-default: desc :param since: (optional), Only issues after this date will be returned. This can be a `datetime` or an ISO8601 formatted date string, e.g., 2012-05-20T23:10:27Z :type since: :class:`~datetime.datetime` or str :param int number: (optional), number of issues to return. Default: -1 returns all issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of issues :rtype: :class:`~github3.issues.ShortIssue` r8r )rc)r@r rYr$rXrYr) r&rZr:rr[r\rbrcr\rWrIres r+ user_issuesGitHub.user_issues s[voofh/$$ 6   x (zz#f+sF,=,=vLLr-cxURSS5nUR[U5U[RUS9$)a6Get the authenticated user's teams across all of organizations. List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth. :returns: generator of teams :rtype: :class:`~github3.orgs.ShortTeam` r8teamsrV)r@rXrYr ShortTeamr[s r+ user_teamsGitHub.user_teamsX s3oofg.zz#f+sDNNzFFr-c[U5nSnUS:a<URS[U55nURUR U5S5nUR [ RU5$)zGet the user's information with id ``number``. :param int number: the user's id number :returns: the user :rtype: :class:`~github3.users.User` Nrr8r>)rYr@ryrArzrErrRrs r+ user_with_idGitHub.user_with_idh s\V A://&#f+6C::diinc2D%%ejj$77r-cURS5nURU5nURS:Xa UR$SR S5$)ztReturn a quote from the Zen of GitHub. Yet another API Easter Egg :returns: the zen of GitHub :rtype: str zenr>r-zutf-8)r@rz status_coderdecode)r&rIrs r+r` GitHub.zeny sDooe$yy~ ,,3tyyLG9LLr-)r>r>r>Nr>)N)reNNN)re)Nr>r>r>r>)T)F)r>r>FTTFr>T)r>r>r>r>r>NreN) NNNNNNNNreN)NNNN))r>r>F)FFreN)N)reNN)NreN)r>)NNNreN)NNNFreN)NNreN)NNNNNFN) r>r>r>r>r>NNreN)~__name__ __module__ __qualname____firstlineno____doc__r!r5rrJrSr]rirortr}rrequires_app_bearer_authrrrrrrequires_app_installation_authrrrrrrrYtOptionalry GeneratorrrsrUserLikeboolrrrrrrrrrrrMrrr r$r(r,rr2rr9rrCrFrrLrPrUr rbrrrjr r%rDEFAULT_JWT_TOKEN_EXPIRATIONr{rrrrrr rrGrr`rrrrrrrrrrlrrrrrrrrrrr"r'r*r.r2rOr9r<r?rCrFrOr8rUrZr]r`__static_attributes__ __classcell__r*s@r+rr%s2MO+(7 >>.,.LL E":> <:> : <64((?)?4(( ) 4((?)?4((?)?<((?)?6.. / 8((6)60 A ALL2 5An8<HH&'jjoH U__dD0 1HH( 7enn 7 7 7 : :4 : : 7ENN 7t 7 76 8 8D::" :?:?x7709=9=v/1    DD I"77r H,HH(H,HH( 8HH$H( & 5 : :EE""$:,  6M6Mx  M^77 BB > N C>33 =<CE:7x+ZEE ==,5 >B  < * ?  9M9MvOO(4>&B"D" :  $++Z?(/4DH, , b  0 d=$NN ="110112 G X ^ F Q l R n K ZI @$  <DH  DMM M$ $  ,,\ 8  @M@MD G G8" M Mr-rc`^\rSrSrSrSU4SjjrSr\S5r\S5r Sr U=r $) GitHubEnterprisei a An interface to a specific GitHubEnterprise instance. For GitHub Enterprise users, this object will act as the public API to your instance. You must provide the URL to your instance upon initialization and can provide the rest of the login details just like in the :class:`GitHub ` object. There is no need to provide the end of the url (e.g., /api/v3/), that will be taken care of by us. If you have a self signed SSL for your local github enterprise you can override the validation by passing `verify=False`. c>[TU]X#XFS9 URS5S-URlXPRlXlg)z1Create a client for a GitHub Enterprise instance.r/z/api/v3N)r r!rstriprbase_urlverifyrI)r&rIr'r(rr}rr*s r+r!GitHubEnterprise.__init__ s? UD # 3) ; $ r-c"SURS3$)Nz` adminr)r%rRr<rN)r@rArOrErrs)r&r%rRrIpayload json_datas r+ create_userGitHubEnterprise.create_user sN"oogw/!2JJtzz#z)rr@rArz)r&optionrrIs r+ admin_statsGitHubEnterprise.admin_stats sS <<>  //,HCJJtyy~s3E r-r)r>r>r>TN) rgrhrirjrkr!r5rrrrtrurvs@r+rxrx sM " 3BB*r-rx)#rkrCretypingrnr r>rrrrrr r r r r rrrrrrrrrrrrrcompiler GitHubCorerrxrdr-r+rs: 0%+ZZ= `-MV  `-MF[TvTr-