mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
Steve Kowalik
83bef0f7b2
Correct misspellings and typos located using the codespell tool. Add codespell to pre-commit to avoid further regressions. Fixes #1459
85 lines
3.8 KiB
Python
85 lines
3.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2012 Zearin <zearin@gonk.net> #
|
|
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
|
|
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
|
|
# Copyright 2017 sharkykh <sharkykh@gmail.com> #
|
|
# Copyright 2018 sfdye <tsfdye@gmail.com> #
|
|
# #
|
|
# This file is part of PyGithub. #
|
|
# http://pygithub.readthedocs.io/ #
|
|
# #
|
|
# PyGithub is free software: you can redistribute it and/or modify it under #
|
|
# the terms of the GNU Lesser General Public License as published by the Free #
|
|
# Software Foundation, either version 3 of the License, or (at your option) #
|
|
# any later version. #
|
|
# #
|
|
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
|
# details. #
|
|
# #
|
|
# You should have received a copy of the GNU Lesser General Public License #
|
|
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
"""
|
|
The primary class you will instantiate is :class:`github.MainClass.Github`.
|
|
From its ``get_``, ``create_`` methods, you will obtain instances of all Github objects
|
|
like :class:`github.NamedUser.NamedUser` or :class:`github.Repository.Repository`.
|
|
|
|
All classes inherit from :class:`github.GithubObject.GithubObject`.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from github.MainClass import Github, GithubIntegration
|
|
|
|
from .GithubException import ( # type: ignore
|
|
BadAttributeException,
|
|
BadCredentialsException,
|
|
BadUserAgentException,
|
|
GithubException,
|
|
IncompletableObject,
|
|
RateLimitExceededException,
|
|
TwoFactorException,
|
|
UnknownObjectException,
|
|
)
|
|
from .InputFileContent import InputFileContent
|
|
from .InputGitAuthor import InputGitAuthor
|
|
from .InputGitTreeElement import InputGitTreeElement
|
|
|
|
|
|
def enable_console_debug_logging(): # pragma no cover (Function useful only outside test environment)
|
|
"""
|
|
This function sets up a very simple logging configuration (log everything on standard output) that is useful for troubleshooting.
|
|
"""
|
|
|
|
logger = logging.getLogger("github")
|
|
logger.setLevel(logging.DEBUG)
|
|
logger.addHandler(logging.StreamHandler())
|
|
|
|
|
|
__all__ = [
|
|
BadAttributeException,
|
|
BadCredentialsException,
|
|
BadUserAgentException,
|
|
enable_console_debug_logging,
|
|
Github,
|
|
GithubException,
|
|
GithubIntegration,
|
|
IncompletableObject,
|
|
InputFileContent,
|
|
InputGitAuthor,
|
|
InputGitTreeElement,
|
|
RateLimitExceededException,
|
|
TwoFactorException,
|
|
UnknownObjectException,
|
|
]
|