Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b0f9519
commit e1cf03c
Showing
3 changed files
with
20 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -54,3 +54,5 @@ | |
| venv | ||
| .tox/ | ||
| .mypy_cache/ | ||
| /release.sh | ||
| /Polidoro_PyGithub.egg-info/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,21 @@ | ||
| # PyGitHub | ||
| # Disclaimer | ||
| This is just a fork for the original [PyGitHub](https://github.com/PyGithub/PyGithub) | ||
| just to use the the features implemented in: | ||
|
|
||
| [](https://pypi.python.org/pypi/PyGithub) | ||
|  | ||
| [](https://pygithub.readthedocs.io/en/stable/?badge=stable) | ||
| [](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License) | ||
| [](https://join.slack.com/t/pygithub-project/shared_invite/zt-duj89xtx-uKFZtgAg209o6Vweqm8xeQ) | ||
| [](https://www.codetriage.com/pygithub/pygithub) | ||
| [](https://codecov.io/gh/PyGithub/PyGithub) | ||
| [](https://github.com/psf/black) | ||
| - [](https://github.com/PyGithub/PyGithub/pull/2816) | ||
| - [](https://github.com/PyGithub/PyGithub/pull/2816) | ||
|
|
||
| PyGitHub is a Python library to access the [GitHub REST API]. | ||
| This library enables you to manage [GitHub] resources such as repositories, user profiles, and organizations in your Python applications. | ||
| When these PRs are released this repository and the PyPi releases will be removed! | ||
|
|
||
| [GitHub REST API]: https://docs.github.com/en/rest | ||
| [GitHub]: https://github.com | ||
| |  |  | | ||
| |------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------| | ||
| |  | [](https://pypi.python.org/pypi/Polidoro-PyGithub) | | ||
| |  | [](https://pypi.python.org/pypi/PyGithub) | | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| pip install PyGithub | ||
| pip install Polidoro-PyGithub | ||
| ``` | ||
|
|
||
| ## Simple Demo | ||
|
|
||
| ```python | ||
| from github import Github | ||
|
|
||
| # Authentication is defined via github.Auth | ||
| from github import Auth | ||
|
|
||
| # using an access token | ||
| auth = Auth.Token("access_token") | ||
|
|
||
| # First create a Github instance: | ||
|
|
||
| # Public Web Github | ||
| g = Github(auth=auth) | ||
|
|
||
| # Github Enterprise with custom hostname | ||
| g = Github(base_url="https://{hostname}/api/v3", auth=auth) | ||
|
|
||
| # Then play with your Github objects: | ||
| for repo in g.get_user().get_repos(): | ||
| print(repo.name) | ||
|
|
||
| # To close connections after use | ||
| g.close() | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| More information can be found on the [PyGitHub documentation site.](https://pygithub.readthedocs.io/en/stable/introduction.html) | ||
|
|
||
| ## Development | ||
|
|
||
| ### Contributing | ||
|
|
||
| Long-term discussion and bug reports are maintained via GitHub Issues. | ||
| Code review is done via GitHub Pull Requests. | ||
|
|
||
| For more information read [CONTRIBUTING.md]. | ||
|
|
||
| [CONTRIBUTING.md]: /CONTRIBUTING.md | ||
|
|
||
| ### Maintainership | ||
|
|
||
| We're actively seeking maintainers that will triage issues and pull requests and cut releases. | ||
| If you work on a project that leverages PyGitHub and have a vested interest in keeping the code alive and well, send an email to someone in the MAINTAINERS file. | ||
| More info check the original repository [PyGitHub](https://github.com/PyGithub/PyGithub) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters