Metadata-Version: 2.1
Name: gidgetlab
Version: 0.1.0
Summary: An async GitLab API library
Home-page: https://gitlab.com/beenje/gidgetlab
Author: Benjamin Bertrand
Author-email: beenje@gmail.com
License: Apache
Keywords: gitlab sans-io async
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6.0
Provides-Extra: docs
Provides-Extra: dev
Provides-Extra: aiohttp
Provides-Extra: tests
Provides-Extra: tornado
Provides-Extra: treq
Requires-Dist: uritemplate (>=3.0.0)
Provides-Extra: aiohttp
Requires-Dist: aiohttp; extra == 'aiohttp'
Provides-Extra: dev
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: pytest (>=3.0.0); extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: aiohttp; extra == 'dev'
Requires-Dist: treq; extra == 'dev'
Requires-Dist: twisted[tls]; extra == 'dev'
Requires-Dist: tornado; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (>=3.0.0); extra == 'tests'
Requires-Dist: pytest-asyncio; extra == 'tests'
Provides-Extra: tornado
Requires-Dist: tornado; extra == 'tornado'
Provides-Extra: treq
Requires-Dist: treq; extra == 'treq'
Requires-Dist: twisted[tls]; extra == 'treq'

gidgetlab
=========

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black

An asynchronous `GitLab API <https://docs.gitlab.com/ce/api/>`_ library.

This library is based on `gidgethub <https://github.com/brettcannon/gidgethub>`_ from Brett Cannon,
an async GitHub API library.

I liked the concept and decided to adapt it to the GitLab API.
All credit to `Brett Cannon <https://github.com/brettcannon/>`_ for the initial library.


Installation
------------

Gidgetlab is `available on PyPI <https://pypi.org/project/gidgetlab/>`_.

::

  python3 -m pip install gidgetlab


Note that the library is still in alpha development stage.

Goals
-----

The key goal is the same as `gidgethub <https://gidgethub.readthedocs.io/>`_ (but for GitLab):
to provide a base library for the `GitLab API <https://docs.gitlab.com/ce/api/>`_
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 GitLab-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 GitLab API,
`GitLab maintains a list of libraries <https://about.gitlab.com/applications/#api-clients/>`_.


