Metadata-Version: 2.1
Name: gitlablib
Version: 0.1.dev0
Summary: An unofficial Python 3 client for the GitLab API
Home-page: https://github.com/jdhp/gitlab-lib
Author: Jérémie DECOCK
Author-email: jd.jdhp@gmail.com
Project-URL: Bug Tracker, https://github.com/jdhp/gitlab-lib/issues
Keywords: gitlablib
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS

========================
Python Client for GitLab
========================

Copyright (c) 2022 Jérémie DECOCK (www.jdhp.org)

* Web site: http://www.jdhp.org/software_en.html#gitlablib
* Online documentation: http://gitlablib.readthedocs.org
* Examples: http://gitlablib.readthedocs.org/gallery/

* Notebooks: https://github.com/jdhp/gitlab-lib-notebooks
* Source code: https://github.com/jdhp/gitlab-lib
* Issue tracker: https://github.com/jdhp/gitlab-lib/issues
* Python Client for GitLab on PyPI: https://pypi.org/project/gitlablib
* Python Client for GitLab on Anaconda Cloud: https://anaconda.org/jdhp/gitlablib


Description
===========

An unofficial Python 3 client for the GitLab API

Note:

    This project is still in beta stage, so the API is not finalized yet.


Dependencies
============

*  Python >= 3.0

.. _install:

Installation
============

Gnu/Linux
---------

You can install, upgrade, uninstall Python Client for GitLab with these commands (in a
terminal)::

    pip install --pre gitlablib
    pip install --upgrade gitlablib
    pip uninstall gitlablib

Or, if you have downloaded the Python Client for GitLab source code::

    python3 setup.py install

.. There's also a package for Debian/Ubuntu::
.. 
..     sudo apt-get install gitlablib

Windows
-------

.. Note:
.. 
..     The following installation procedure has been tested to work with Python
..     3.4 under Windows 7.
..     It should also work with recent Windows systems.

You can install, upgrade, uninstall Python Client for GitLab with these commands (in a
`command prompt`_)::

    py -m pip install --pre gitlablib
    py -m pip install --upgrade gitlablib
    py -m pip uninstall gitlablib

Or, if you have downloaded the Python Client for GitLab source code::

    py setup.py install

MacOSX
-------

.. Note:
.. 
..     The following installation procedure has been tested to work with Python
..     3.5 under MacOSX 10.9 (*Mavericks*).
..     It should also work with recent MacOSX systems.

You can install, upgrade, uninstall Python Client for GitLab with these commands (in a
terminal)::

    pip install --pre gitlablib
    pip install --upgrade gitlablib
    pip uninstall gitlablib

Or, if you have downloaded the Python Client for GitLab source code::

    python3 setup.py install


Documentation
=============

* Online documentation: http://gitlablib.readthedocs.org
* API documentation: http://gitlablib.readthedocs.org/en/latest/api.html


Example usage
=============

TODO


Bug reports
===========

To search for bugs or report them, please use the Python Client for GitLab Bug Tracker at:

    https://github.com/jdhp/gitlab-lib/issues


License
=======

This project is provided under the terms and conditions of the `MIT License`_.


.. _MIT License: http://opensource.org/licenses/MIT
.. _command prompt: https://en.wikipedia.org/wiki/Cmd.exe
