An async GitLab API library
Project description
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/>`_.
=========
.. 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/>`_.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gidgetlab-0.1.0.tar.gz
(21.2 kB
view hashes)
Built Distribution
gidgetlab-0.1.0-py3-none-any.whl
(21.9 kB
view hashes)
Close
Hashes for gidgetlab-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c384781d20cd13b577c8b003bda1639b4f77a16503111f1ca4c8c48479650d7 |
|
MD5 | 141c141e9853c86e3100162e1b590b5a |
|
BLAKE2b-256 | 8c3bc510d451692b9d1e8facf459ab23c7ec54e9ecb508c46c297e48a0c4d4bb |