ansys.tools.meilisearch.get_pages#

Query for public GitHub pages.

Classes#

GitHubPages

Query GitHub for the public gh-pages in an organization.

Module Contents#

class ansys.tools.meilisearch.get_pages.GitHubPages(org_name, token=None, ignore_githubio=True)#

Query GitHub for the public gh-pages in an organization.

Parameters:
org_namestr

Name of the the GitHub organization.

tokenstr, default: None

GitHub API token to use for authentication.

ignore_githubiobool, default: True

Whether to ignore any URL for a GitHub page with github.io in it.

property org_name#

Name of the GitHub organization.

get_public_pages()#

Get the public pages in the repositories in a GitHub organization.

Returns:
dict

Dictionary containing full repository names and public GitHub URLs for the GitHub organization.