Metadata-Version: 2.4
Name: gidgethub
Version: 6.0.0
Summary: An async GitHub API library
Keywords: github,sans-io,async
Author-Email: Brett Cannon <brett@python.org>
Maintainer-Email: Mariatta <mariatta@mariatta.ca>
License-Expression: Apache-2.0 AND MIT
License-File: LICENSE
License-File: Third-Party-Notices.md
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 6 - Mature
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Project-URL: Documentation, https://gidgethub.readthedocs.io
Project-URL: Repository, https://github.com/gidgethub/gidgethub
Requires-Python: >=3.10
Requires-Dist: uritemplate>=3.0.1
Requires-Dist: PyJWT[crypto]>=2.4.0
Requires-Dist: typing_extensions>=4.0.0
Provides-Extra: aiohttp
Requires-Dist: aiohttp; extra == "aiohttp"
Provides-Extra: tornado
Requires-Dist: tornado; extra == "tornado"
Provides-Extra: httpx
Requires-Dist: httpx2; extra == "httpx"
Provides-Extra: httpx2
Requires-Dist: httpx2; extra == "httpx2"
Description-Content-Type: text/x-rst

gidgethub
=========
An asynchronous `GitHub API <https://docs.github.com/>`_ library.


Development status
------------------

.. image:: https://github.com/gidgethub/gidgethub/actions/workflows/main.yml/badge.svg
    :target: https://github.com/gidgethub/gidgethub/actions/workflows/main.yml

.. image:: https://codecov.io/gh/gidgethub/gidgethub/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/gidgethub/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.10 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 to work
with.


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>`_.


Project status
--------------

This project is in maintenance mode. We welcome bug reports and will make a
best-effort at fixing them. We do **not** accept features requests or pull requests
from external contributors.


*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>`_.
