Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyapi-gitlab/pyapi-gitlab

pyapi-gitlab is a python wrapper for the Gitlab API.
https://github.com/pyapi-gitlab/pyapi-gitlab

Last synced: 13 days ago
JSON representation

pyapi-gitlab is a python wrapper for the Gitlab API.

Awesome Lists containing this project

README 

        
Looking for contributors

========================



If you are interested in contributing to this wrapper we ask that all

pull requests have an open issue that and they be referenced. We also

ask that you submit unit tests for your changes to make sure there are

no regressions.



Pull Requests

-------------



We are currently working on getting pyapi-gitlab to 101% coverage in

both unittests and integration tests. Well the integration testing is

not fully flushed out yet the unittests are so we ask that all new pull

requests have unittests with them.



Setting up for development

--------------------------



If you wish to setup your system for development you will need to

install the test requirements and we ask that you consider docker and

docker-compose for integration testing.



To install the test requirements you will need to run the following

command ``pip install -Ur test-requirements.txt``. This will install

both the ``requirements.txt`` and the ``test-requirements.txt``.



To run the test simply run ``./cov`` from the project root directory.



To review the cover open the ``index.html`` file in the

``coverage_html_report``.



To run the integration test run the commands below. This will build the

docker containers and then start them. The containers will shutdown

after the tests finish.



::



    docker-compose -f docker/v93/docker-compose.yml build

    docker-compose -f docker/v93/docker-compose.yml up --abort-on-container-exit



pyapi-gitlab

============



pyapi-gitlab is a python wrapper for the `Gitlab

API `__.



|Build Status| |Coverage Status| |PyPI| |PyPi downloads| |Requirements

Status| |License| |Docs|



Requirements

------------



-  requests



Naming convention

-----------------



pyapi-gitlab has its own versioning in which the 2 first numbers

indicates the Gitlab version that its supported for that library. a 7.5

version means that its compatible with the Gitlab 7.5 and lower API

versions.



Installation

------------



.. code:: bash



    pip install pyapi-gitlab



pyapi-gitlab supports python version 2.7, 3.3, 3.4, 3.5, 3.5-dev, 3.6,

3.6-dev, 3.7-dev, and the nightly build



Versions tested

===============

+------------------+------------------------+

| Gitlab version   | Status                 |

+==================+========================+

| 9.1.X            | :x:1                   |

+------------------+------------------------+

| 7.9.X            | :x:2                   |

+------------------+------------------------+

| 7.8.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.7.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.6.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.5.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.4.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.3.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.2.X            | :heavy_check_mark:0    |

+------------------+------------------------+

| 7.1.X            | :x:3                   |

+------------------+------------------------+

| 7.0.X            | :x:4                   |

+------------------+------------------------+



0. Placeholder to get :heavy_check_mark: working

1. Currently under development

2. 3 out of 17 tests failing: Seems that create snippet wall note now

   returns true/false instead of the created snippet. Snippet creating

   now does not return the created snippet. And move project does not

   return a dict either.

3. Label creation is not supported on this version.

4. Contributors endpoint seems to not exists in this version. Label

   creation is not supported on this version.



Changelog

---------



7.8.5

=====



-  Use ``requests.json()`` instead of decoding everything (@satreix)

-  Add getmergerequestchanges (@bor-sh)

-  Add getmilestoneissues (@JonathonReinhart)

-  Add editproject (@nelg)

-  Add editgroupmember (@)

-  Fix hook metadata creation #137 (@jzelinskie)

-  Fix addprojectmember (@btall)

-  Fix Raise exception instead of returning it in creategroup (@brenard)



7.8.4

=====



-  Just a bumped version, now that its tested and fully supports Gitlab

   versions up to 7.8



7.5.4

=====



-  Change license to Apache 2.0

-  getproject now accepts a namespace/projectname as well like the

   gitlab api



7.5.3

=====



-  New function wrapper ``getall`` to get all results from any function

   that provides pagination [Anirudh Dutt]

-  Remove pagination params from ``getdeploykeys``, ``getbranches`` and

   ``getsshkeys`` as they don't support it [Anirudh Dutt]

-  Add oAuth tokens to the login method [Ken Cochrane]

-  You can now add the type of hook when creating it [tonicbupt]

-  Allow Project Issues to be filtered by passing kwargs [Nick Whyte]

-  Update docs [Itxaka Serrano]



7.5.2

=====



-  Support for the full Gitlab 7.5 API

-  Fix python 2.6 compatibility

-  All methods have documentation (Inside the library only, the docs are

   lagging a bit behind).

-  New fork api that allows to actually fork a project instead of doing

   fork relations

-  New label methods (getlabel, createlabel, editlabel, deletelabel)

-  All get\* methods that return more than one item support pagination.

   Check page and per\_page args. Default to first page and 20 items per

   page.

-  BREAKING CHANGE: Old sudo arg in methods to execute as other user is

   gone. Now there is a method setsudo(user\_id/user\_username) which

   will setup the header, so all the subsequent API calls will be done

   as that user. To get back to your user just do a setsudo() and the

   sudo parameter will be cleared

-  BREAKING CHANGE: Some methods were returning True or False instead of

   the object created. Now all the methods in which there is something

   returning from the server is returned as a dictionary/list of

   dictionaries to the user

-  BREAKING CHANGE: Some methods now use kwargs for the optional

   parameters so the code is more easy and readable. Methods affected:

   createproject, createprojectuser, createmilestone, editmilestone,

   updatemergerequest

-  BREAKING CHANGE: Project wallnotes does not exist anymore, seems that

   they have been moved to project snippets (getsnippets, getsnippet,

   createsnippet, deletesnippet)

-  BREAKING CHANGE: Removed getreadme method as its not part of the

   gitlab api, nor was it ever.

-  BREAKING CHANGE: Old methods that started with list\* are not get\*.

   This is done in order to have a proper naming convention instead of

   having mixed listsomething and then getsomething. The actual

-  BREAKING CHANGE: Old methods with new names: getownprojects ->

   getprojectsowned, getallprojects -> getprojectsall



Examples/Documentation

----------------------



Check the docs at

`readthedocs.org `__



License

-------



pyapi-gitlab is licensed under the Apache License 2.0. Check the LICENSE

file.



Built with PyCharm

------------------



Thanks to Jetbrains for giving me an Open Source license for PyCharm, it

has helped making development much faster!



|Pycharm|



.. |Build Status| image:: https://travis-ci.org/pyapi-gitlab/pyapi-gitlab.svg?branch=develop

   :target: https://travis-ci.org/pyapi-gitlab/pyapi-gitlab

.. |Coverage Status| image:: https://codecov.io/gh/pyapi-gitlab/pyapi-gitlab/branch/develop/graph/badge.svg

  :target: https://codecov.io/gh/pyapi-gitlab/pyapi-gitlab

.. |PyPI| image:: https://img.shields.io/pypi/v/pyapi-gitlab.svg

   :target: https://pypi.python.org/pypi/pyapi-gitlab

.. |PyPi downloads| image:: https://img.shields.io/pypi/dm/pyapi-gitlab.svg

.. |Requirements Status| image:: https://requires.io/github/pyapi-gitlab/pyapi-gitlab/requirements.svg?branch=develop

   :target: https://requires.io/github/pyapi-gitlab/pyapi-gitlab/requirements/?branch=develop

.. |License| image:: http://img.shields.io/pypi/l/pyapi-gitlab.svg

   :target: https://www.apache.org/licenses/LICENSE-2.0.txt

.. |Docs| image:: https://readthedocs.org/projects/pyapi-gitlab/badge/?version=latest

   :target: http://pyapi-gitlab.readthedocs.org/

.. |Pycharm| image:: http://www.jetbrains.com/pycharm/docs/logo_pycharm.png

   :target: https://www.jetbrains.com/pycharm/