NamedUser¶

class github.NamedUser.NamedUser¶

This class represents NamedUsers.

The reference can be found here https://docs.github.com/en/rest/reference/users#get-a-user

The OpenAPI schema can be found at - /components/schemas/actor - /components/schemas/collaborator - /components/schemas/contributor - /components/schemas/nullable-simple-user - /components/schemas/public-user - /components/schemas/simple-user - /components/schemas/user-search-result-item

A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.

A partially initialized CompletableGithubObject (completed=False) can be completed via complete(). This requires the url to be given via parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

Parameters

requester – requester
headers – response headers
attributes – attributes to initialize
completed – do not update non-initialized attributes when True
url – url of this instance, overrides attributes[‘url’]
accept – use this accept header when completing this instance

get_events() → PaginatedList[Event]¶

Calls: GET /users/{user}/events

get_followers() → github.PaginatedList.PaginatedList[github.NamedUser.NamedUser][github.NamedUser.NamedUser]¶

Calls: GET /users/{user}/followers

get_following() → github.PaginatedList.PaginatedList[github.NamedUser.NamedUser][github.NamedUser.NamedUser]¶

Calls: GET /users/{user}/following

get_gists(since: Opt[datetime] = NotSet) → PaginatedList[Gist]¶

Calls: GET /users/{user}/gists

get_keys() → PaginatedList[UserKey]¶

Calls: GET /users/{user}/keys

get_orgs() → PaginatedList[Organization]¶

Calls: GET /users/{user}/orgs

get_projects(state: str = 'open') → PaginatedList[Project]¶

Calls: GET /users/{user}/projects

get_public_events() → PaginatedList[Event]¶

Calls: GET /users/{user}/events/public

get_public_received_events() → PaginatedList[Event]¶

Calls: GET /users/{user}/received_events/public

get_received_events() → PaginatedList[Event]¶

Calls: GET /users/{user}/received_events

get_repo(name: str) → Repository¶

Calls: GET /repos/{owner}/{repo}

get_repos(type: Opt[str] = NotSet, sort: Opt[str] = NotSet, direction: Opt[str] = NotSet) → PaginatedList[Repository]¶

Calls: GET /users/{user}/repos

get_starred() → PaginatedList[Repository]¶

Calls: GET /users/{user}/starred

get_subscriptions() → PaginatedList[Repository]¶

Calls: GET /users/{user}/subscriptions

get_watched() → PaginatedList[Repository]¶

Calls: GET /users/{user}/watched

has_in_following(following: github.NamedUser.NamedUser) → bool¶

Calls: GET /users/{user}/following/{target_user}

get_organization_membership(org: str | Organization) → Membership¶

Calls: GET /orgs/{org}/memberships/{username}