Documentation for github enterprise

[mambon2]

All of the documentation is geared for public github user owned repos.
I failed to find any examples for github enterprise where we must:

• provide auth token and config to the class init
• query the org rest api for list of orgs
• query the repo rest api by org name

Can you please provide usage for the above cases and update the documentation?
thank you, P.

[yanyongyu]

Hi @mambon2 , thanks for using githubkit 😄 . Since I don't have a GitHub Enterprise account, I can only provide some usage suggestions. If you encounter any problems, please feel free to ask here.

Note that, githubkit currently supports GitHub and GHEC API schemas, not tested with GHES. If you want to use GHES schemas, i need to generate one. (Most API schemas should be compatible with GHEC)

About documentation, i will add the examples to the docs after the tests successfully.

---

First, you need to auth to the enterprise server with your token and enterprise server address (ref docs):

from githubkit import GitHub

g = GitHub("<your token here>", base_url="https://example.ghe.com/api/v3/")

Then, you can use the client to interact with the server APIs (ref docs):

# switch the api version to ghec
for org in g.rest.paginate(g.rest("ghec-2022-11-28").orgs.list):
    for repo in g.rest.paginate(
        g.rest("ghec-2022-11-28").repos.list_for_org, org=org.login, type="all"
    ):
        print(repo.name)

[mambon2]

thanks @yanyongyu I'm getting a TypeError with above code so I'll wait until the tested docs are published

TypeError: ReposClient.list_for_org() missing 1 required positional argument: 'org'

[yanyongyu]

@mambon2 Sorry for missing the param name in the example code. The argument name org should be added:

-         g.rest("ghec-2022-11-28").repos.list_for_org, org.login, type="all"
+         g.rest("ghec-2022-11-28").repos.list_for_org, org=org.login, type="all"

so I'll wait until the tested docs are published

I don't have a GHES account 😢 . So i may not be able to test the code actually. If you have the account, could you please help me test the code? I will add this to the docs once it works well. Thanks.

[mambon2]

thanks that works, but I was actually trying to fetch only type="archived" but that seems to still get me all repos. is there a way to fetch only archived or do I have to filter post?

[mambon2]

would be great if I could get async with graphQL :)

[yanyongyu]

trying to fetch only type="archived" but that seems to still get me all repos

From the github's documentation, the type param should be one of all, public, private, forks, sources, member, internal. You should iter over the repos and check the repo.archived attribute:

# switch the api version to ghec
for org in g.rest.paginate(g.rest("ghec-2022-11-28").orgs.list):
    for repo in g.rest.paginate(
        g.rest("ghec-2022-11-28").repos.list_for_org, org=org.login, type="all"
    ):
        if repo.archived:
            print(repo.name)

would be great if I could get async with graphQL :)

Sure, you can use async with both rest api and graphql:

# Rest API
async for org in g.rest.paginate(g.rest("ghec-2022-11-28").orgs.async_list):
    async for repo in g.rest.paginate(
        g.rest("ghec-2022-11-28").repos.async_list_for_org, org=org.login, type="all"
    ):
        if repo.archived:
            print(repo.name)

# GraphQL
query = """
query GetArchivedRepos($org: String!, $cursor: String) {
  organization(login: $org) {
    repositories(first: 100, isArchived: true, after: $cursor) {
      nodes {
        name
      }
      pageInfo {
        endCursor
        hasNextPage
      }
    }
  }
}
"""
async for result in g.graphql.paginate(query, {"org": "example"}):
    for repo in result["organization"]["repositories"]["nodes"]:
        print(repo["name"])

[yanyongyu]

I have just add a simple quick start guide for connecting to GHE at https://yanyongyu.github.io/githubkit/quickstart/connecting-to-github-enterprise/

[mambon2]

@yanyongyu thank you! this works great. Maybe we could leave them as examples in the docs :)