| Name | gidgethub JSON |
| Version |
5.3.0
JSON |
| download |
| home_page | None |
| Summary | An async GitHub API library |
| upload_time | 2023-05-30 19:50:16 |
| maintainer | None |
| docs_url | None |
| author | Brett Cannon |
| requires_python | >=3.7 |
| license | Apache |
| keywords |
github
sans-io
async
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
gidgethub
=========
An asynchronous `GitHub API <https://docs.github.com/>`_ library.
Development status
------------------
.. image:: https://github.com/brettcannon/gidgethub/workflows/CI/badge.svg?event=push
:target: https://github.com/brettcannon/gidgethub/actions
.. image:: https://codecov.io/gh/brettcannon/gidgethub/branch/master/graph/badge.svg
:target: https://codecov.io/gh/brettcannon/gidgethub
.. image:: https://readthedocs.org/projects/gidgethub/badge/?version=latest
:target: http://gidgethub.readthedocs.io/en/latest/
:alt: Documentation Status
Installation
------------
Gidgethub is `available on PyPI <https://pypi.org/project/gidgethub/>`_.
::
python3 -m pip install gidgethub
Gidgethub requires Python version 3.7 and up.
Goals
-----
The key goal is to provide a base library for the
`GitHub API <https://docs.github.com/>`_ which performs no I/O of its own (a
`sans-I/O <https://sans-io.readthedocs.io/>`_ library). This allows users to
choose whatever HTTP library they prefer while parceling out GitHub-specific
details to this library. This base library is then built upon to provide an
abstract base class to a cleaner API to work with. Finally, implementations of
the abstract base class are provided for asynchronous HTTP libraries for
immediate usage.
Alternative libraries
---------------------
If you think you want a different approach to the GitHub API,
`GitHub maintains a list of libraries <https://docs.github.com/en/free-pro-team@latest/rest/overview/libraries>`_.
*Aside*: what's with the name?
------------------------------
I couldn't think of a good name that was somehow a play on "GitHub" or somehow
tied into `Monty Python <http://www.montypython.com/>`_. And so I decided to play
off of GitHub's `octocat <https://octodex.github.com/>`_ mascot and use my own
cat's name, Gidget, in some way. Since "Gidget" somewhat sounds like
"git", I decided to go with "gidgethub".
Changelog
---------
See the documentation for the `full changelog <https://gidgethub.readthedocs.io/en/latest/changelog.html>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "gidgethub",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "github sans-io async",
"author": "Brett Cannon",
"author_email": "brett@python.org",
"download_url": "https://files.pythonhosted.org/packages/58/6d/c3c7f2b3d2a8249913f214b254d547db2b026ff4c7d38cebd7d88940725c/gidgethub-5.3.0.tar.gz",
"platform": null,
"description": "gidgethub\n=========\nAn asynchronous `GitHub API <https://docs.github.com/>`_ library.\n\n\nDevelopment status\n------------------\n\n.. image:: https://github.com/brettcannon/gidgethub/workflows/CI/badge.svg?event=push\n :target: https://github.com/brettcannon/gidgethub/actions\n\n.. image:: https://codecov.io/gh/brettcannon/gidgethub/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/brettcannon/gidgethub\n\n.. image:: https://readthedocs.org/projects/gidgethub/badge/?version=latest\n :target: http://gidgethub.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n\nInstallation\n------------\nGidgethub is `available on PyPI <https://pypi.org/project/gidgethub/>`_.\n::\n\n python3 -m pip install gidgethub\n\n\nGidgethub requires Python version 3.7 and up.\n\n\nGoals\n-----\n\nThe key goal is to provide a base library for the\n`GitHub API <https://docs.github.com/>`_ which performs no I/O of its own (a\n`sans-I/O <https://sans-io.readthedocs.io/>`_ library). This allows users to\nchoose whatever HTTP library they prefer while parceling out GitHub-specific\ndetails to this library. This base library is then built upon to provide an\nabstract base class to a cleaner API to work with. Finally, implementations of\nthe abstract base class are provided for asynchronous HTTP libraries for\nimmediate usage.\n\n\nAlternative libraries\n---------------------\n\nIf you think you want a different approach to the GitHub API,\n`GitHub maintains a list of libraries <https://docs.github.com/en/free-pro-team@latest/rest/overview/libraries>`_.\n\n\n*Aside*: what's with the name?\n------------------------------\n\nI couldn't think of a good name that was somehow a play on \"GitHub\" or somehow\ntied into `Monty Python <http://www.montypython.com/>`_. And so I decided to play\noff of GitHub's `octocat <https://octodex.github.com/>`_ mascot and use my own\ncat's name, Gidget, in some way. Since \"Gidget\" somewhat sounds like\n\"git\", I decided to go with \"gidgethub\".\n\n\nChangelog\n---------\n\nSee the documentation for the `full changelog <https://gidgethub.readthedocs.io/en/latest/changelog.html>`_.\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "An async GitHub API library",
"version": "5.3.0",
"project_urls": {
"Documentation": "https://gidgethub.readthedocs.io",
"Repository": "https://github.com/brettcannon/gidgethub"
},
"split_keywords": [
"github",
"sans-io",
"async"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0fe6659924caa8b03cf06395775eb046ed4701913791d2b6afef8a4cf2861c92",
"md5": "1a8ee9b260142ed2c1d28649221d6753",
"sha256": "4dd92f2252d12756b13f9dd15cde322bfb0d625b6fb5d680da1567ec74b462c0"
},
"downloads": -1,
"filename": "gidgethub-5.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a8ee9b260142ed2c1d28649221d6753",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 21244,
"upload_time": "2023-05-30T19:50:12",
"upload_time_iso_8601": "2023-05-30T19:50:12.491295Z",
"url": "https://files.pythonhosted.org/packages/0f/e6/659924caa8b03cf06395775eb046ed4701913791d2b6afef8a4cf2861c92/gidgethub-5.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "586dc3c7f2b3d2a8249913f214b254d547db2b026ff4c7d38cebd7d88940725c",
"md5": "0007e6e4a2907a25dadc46523cf1817f",
"sha256": "9ece7d37fbceb819b80560e7ed58f936e48a65d37ec5f56db79145156b426a25"
},
"downloads": -1,
"filename": "gidgethub-5.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0007e6e4a2907a25dadc46523cf1817f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 125885,
"upload_time": "2023-05-30T19:50:16",
"upload_time_iso_8601": "2023-05-30T19:50:16.360038Z",
"url": "https://files.pythonhosted.org/packages/58/6d/c3c7f2b3d2a8249913f214b254d547db2b026ff4c7d38cebd7d88940725c/gidgethub-5.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 19:50:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brettcannon",
"github_project": "gidgethub",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gidgethub"
}
