Bug Fixes

• deps: Upgrade requests to 2.25.0 (see CVE-2021-33503) (ce995b2)

• mixins: Improve deprecation warning (57e0187)

Also note what should be changed

Chores

• Define root dir in mypy, not tox (7a64e67)

• Fix mypy pre-commit hook (bd50df6)

• deps: Group typing requirements with mypy additional_dependencies (38597e7)

• deps: Update codecov/codecov-action action to v2 (44f4fb7)

• deps: Update dependency isort to v5.9.3 (ab46e31)

• deps: Update dependency types-pyyaml to v5.4.7 (ec8be67)

• deps: Update dependency types-pyyaml to v5.4.8 (2ae1dd7)

• deps: Update dependency types-requests to v2.25.1 (a2d133a)

• deps: Update dependency types-requests to v2.25.2 (4782678)

• deps: Update precommit hook pycqa/isort to v5.9.3 (e1954f3)

• deps: Update typing dependencies (34fc210)

• deps: Update wagoid/commitlint-github-action action to v4 (ae97196)

Documentation

• mergequests: Gl.mergequests.list documentation was missleading (5b5a7bc)

Bug Fixes

• api: Do not require Release name for creation (98cd03b)

Stop requiring a name attribute for creating a Release, since a release name has not been required since GitLab 12.5.

Chores

• deps: Update dependency isort to v5.9.2 (d5dcf1c)

• deps: Update dependency requests to v2.26.0 (d3ea203)

• deps: Update precommit hook pycqa/isort to v5.9.2 (521cddd)

Documentation

• Add example for mr.merge_ref (b30b8ac)

Signed-off-by: Matej Focko mfocko@redhat.com

• project: Add example on getting a single project using name with namespace (ef16a97)

• readme: Move contributing docs to CONTRIBUTING.rst (edf49a3)

Move the Contributing section of README.rst to CONTRIBUTING.rst, so it is recognized by GitHub and shown when new contributors make pull requests.

Features

• api: Add name_regex_keep attribute in delete_in_bulk() (e49ff3f)

• api: Add merge_ref for merge requests (1e24ab2)

Support merge_ref on merge requests that returns commit of attempted merge of the MR.

Signed-off-by: Matej Focko mfocko@redhat.com

Testing

• functional: Add mr.merge_ref tests (a9924f4)

• Add test for using merge_ref on non-merged MR - Add test for using merge_ref on MR with conflicts

Signed-off-by: Matej Focko mfocko@redhat.com

Chores

• Add new required type packages for mypy (a7371e1)

New version of mypy flagged errors for missing types. Install the recommended type-* packages that resolve the issues.

• Add type-hints to gitlab/v4/objects/projects.py (872dd6d)

Adding type-hints to gitlab/v4/objects/projects.py

• Skip EE test case in functional tests (953f207)

• deps: Update dependency isort to v5.9.1 (0479dba)

• deps: Update dependency mypy to v0.902 (19c9736)

• deps: Update dependency mypy to v0.910 (02a56f3)

• deps: Update dependency types-pyyaml to v0.1.8 (e566767)

• deps: Update dependency types-pyyaml to v0.1.9 (1f5b3c0)

• deps: Update dependency types-pyyaml to v5 (5c22634)

• deps: Update dependency types-requests to v0.1.11 (6ba629c)

• deps: Update dependency types-requests to v0.1.12 (f84c2a8)

• deps: Update dependency types-requests to v0.1.13 (c3ddae2)

• deps: Update dependency types-requests to v2 (a81a926)

• deps: Update precommit hook pycqa/isort to v5.9.1 (c57ffe3)

Documentation

• Make Gitlab class usable for intersphinx (8753add)

• release: Add update example (6254a5f)

• tags: Remove deprecated functions (1b1a827)

Features

• api: Add group hooks (4a7e9b8)

• api: Add MR pipeline manager in favor of pipelines() method (954357c)

• api: Add support for creating/editing reviewers in project merge requests (676d1f6)

• api: Remove responsibility for API inconsistencies for MR reviewers (3d985ee)

• release: Allow to update release (b4c4787)

Release API now supports PUT.

Testing

• releases: Add unit-tests for release update (5b68a5a)

• releases: Integration for release PUT (13bf61d)

Bug Fixes

• Add a check to ensure the MRO is correct (565d548)

Add a check to ensure the MRO (Method Resolution Order) is correct for classes in gitlab.v4.objects when doing type-checking.

An example of an incorrect definition: class ProjectPipeline(RESTObject, RefreshMixin, ObjectDeleteMixin): ^^^^^^^^^^ This should be at the end.

Correct way would be: class ProjectPipeline(RefreshMixin, ObjectDeleteMixin, RESTObject): Correctly at the end ^^^^^^^^^^

Also fix classes which have the issue.

• Catch invalid type used to initialize RESTObject (c7bcc25)

Sometimes we have errors where we don't get a dictionary passed to RESTObject.init() method. This breaks things but in confusing ways.

Check in the init() method and raise an exception if it occurs.

• Change mr.merge() to use 'post_data' (cb6a3c6)

MR https://github.com/python-gitlab/python-gitlab/pull/1121 changed mr.merge() to use 'query_data'. This appears to have been wrong.

From the Gitlab docs they state it should be sent in a payload body https://docs.gitlab.com/ee/api/README.html#request-payload since mr.merge() is a PUT request.

Request Payload

API Requests can use parameters sent as query strings or as a > payload body. GET requests usually send a query string, while PUT > or POST requests usually send the payload body

Fixes: #1452

Related to: #1120

• Ensure kwargs are passed appropriately for ObjectDeleteMixin (4e690c2)

• Functional project service test (#1500, 093db9d)

chore: fix functional project service test

• Iids not working as a list in projects.issues.list() (45f806c)

Set the 'iids' values as type ListAttribute so it will pass the list as a comma-separated string, instead of a list.

Add a functional test.

Closes: #1407

• cli: Add missing list filter for jobs (b3d1c26)

• cli: Fix parsing CLI objects to classnames (4252070)

• objects: Add missing group attributes (d20ff4f)

• objects: Allow lists for filters for in all objects (603a351)

• objects: Return server data in cancel/retry methods (9fed061)

Chores

• Add a functional test for issue #1120 (7d66115)

Going to switch to putting parameters from in the query string to having them in the 'data' body section. Add a functional test to make sure that we don't break anything.

https://github.com/python-gitlab/python-gitlab/issues/1120

• Add a merge_request() pytest fixture and use it (8be2838)

Added a pytest.fixture for merge_request(). Use this fixture in tools/functional/api/test_merge_requests.py

• Add an isort tox environment and run isort in CI (dda646e)

• Add an isort tox environment * Run the isort tox environment using --check in the Github CI

https://pycqa.github.io/isort/

• Add functional test mr.merge() with long commit message (cd5993c)

Functional test to show that https://github.com/python-gitlab/python-gitlab/issues/1452 is fixed.

Added a functional test to ensure that we can use large commit message (10_000+ bytes) in mr.merge()

Related to: #1452

• Add missing linters to pre-commit and pin versions (85bbd1a)

• Add missing optional create parameter for approval_rules (06a6001)

Add missing optional create parameter ('protected_branch_ids') to the project approvalrules.

https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule

• Add type-hints to gitlab/v4/cli.py (2673af0)

• Add type-hints to gitlab/v4/cli.py * Add required type-hints to other files based on adding type-hints to gitlab/v4/cli.py

• Apply suggestions (fe7d19d)

• Apply typing suggestions (a11623b)

Co-authored-by: John Villalovos john@sodarock.com

• Clean up tox, pre-commit and requirements (237b97c)

• Correct a type-hint (046607c)

• Fix import ordering using isort (f3afd34)

Fix the import ordering using isort.

https://pycqa.github.io/isort/

• Have black run at the top-level (429d6c5)

This will ensure everything is formatted with black, including setup.py.

• Have flake8 check the entire project (ab343ef)

Have flake8 run at the top-level of the projects instead of just the gitlab directory.

• Make certain dotfiles searchable by ripgrep (e4ce078)

By explicitly NOT excluding the dotfiles we care about to the .gitignore file we make those files searchable by tools like ripgrep.

By default dotfiles are ignored by ripgrep and other search tools (not grep)

• Make Get.*Mixin._optional_get_attrs always present (3c1a0b3)

Always create GetMixin/GetWithoutIdMixin._optional_get_attrs attribute with a default value of tuple()

This way we don't need to use hasattr() and we will know the type of the attribute.

• Move 'gitlab/tests/' dir to 'tests/unit/' (1ac0722)

Move the 'gitlab/tests/' directory to 'tests/unit/' so we have all the tests located under the 'tests/' directory.

• Mypy: Disallow untyped definitions (6aef2da)

Be more strict and don't allow untyped definitions on the files we check.

Also this adds type-hints for two of the decorators so that now functions/methods decorated by them will have their types be revealed correctly.

• Remove commented-out print (0357c37)

• Rename 'tools/functional/' to 'tests/functional/' (502715d)

Rename the 'tools/functional/' directory to 'tests/functional/'

This makes more sense as these are functional tests and not tools.

This was dicussed in: https://github.com/python-gitlab/python-gitlab/discussions/1468

• Simplify functional tests (df9b5f9)

Add a helper function to have less code duplication in the functional testing.

• Sync create and update attributes for Projects (0044bd2)

Sync the create attributes with: https://docs.gitlab.com/ee/api/projects.html#create-project

Sync the update attributes with documentation at: https://docs.gitlab.com/ee/api/projects.html#edit-project

As a note the ordering of the attributes was done to match the ordering of the attributes in the documentation.

Closes: #1497

• Use built-in function issubclass() instead of getmro() (81f6386)

Code was using inspect.getmro() to replicate the functionality of the built-in function issubclass()

Switch to using issubclass()

• ci: Automate releases (0ef497e)

• ci: Ignore .python-version from pyenv (149953d)

• ci: Ignore debug and type_checking in coverage (885b608)

• ci: Use admin PAT for release workflow (d175d41)

• deps: Update dependency docker-compose to v1.29.2 (fc241e1)

• deps: Update gitlab/gitlab-ce docker tag to v13.11.2-ce.0 (434d15d)

• deps: Update gitlab/gitlab-ce docker tag to v13.11.3-ce.0 (f0b52d8)

• deps: Update gitlab/gitlab-ce docker tag to v13.11.4-ce.0 (4223269)

• deps: Update precommit hook alessandrojcm/commitlint-pre-commit-hook to v5 (9ff349d)

• docs: Fix import order for readthedocs build (c3de1fb)

Code Style

• Clean up test run config (dfa40c1)

Documentation

• Fail on warnings during sphinx build (cbd4d52)

This is useful when docs aren't included in the toctree and don't show up on RTD.

• Fix typo in http_delete docstring (5226f09)

• api: Add behavior in local attributes when updating objects (38f65e8)

Features

• Add code owner approval as attribute (fdc46ba)

The python API was missing the field code_owner_approval_required as implemented in the GitLab REST API.

• Add feature to get inherited member for project/group (e444b39)

• Add keys endpoint (a81525a)

• Add support for lists of integers to ListAttribute (115938b)

Previously ListAttribute only support lists of integers. Now be more flexible and support lists of items which can be coerced into strings, for example integers.

This will help us fix issue #1407 by using ListAttribute for the 'iids' field.

• Indicate that we are a typed package (e4421ca)

By adding the file: py.typed it indicates that python-gitlab is a typed package and contains type-hints.

https://www.python.org/dev/peps/pep-0561/

• api: Add deployment mergerequests interface (fbbc0d4)

• objects: Add pipeline test report support (ee9f96e)

• objects: Add support for billable members (fb0b083)

• objects: Add support for descendant groups API (1b70580)

• objects: Add support for generic packages API (79d88bd)

• objects: Add support for Group wikis (#1484, 74f5e62)

feat(objects): add support for Group wikis

• objects: Support all issues statistics endpoints (f731707)

Testing

• api: Fix issues test (8e5b0de)

Was incorrectly using the issue 'id' vs 'iid'.

• cli: Add more real class scenarios (8cf5031)

• cli: Replace assignment expression (11ae11b)

This is a feature added in 3.8, removing it allows for the test to run with lower python versions.

• functional: Add test for skip_groups list filter (a014774)

• functional: Explicitly remove deploy tokens on reset (19a55d8)

Deploy tokens would remain in the instance if the respective project or group was deleted without explicitly revoking the deploy tokens first.

• functional: Force delete users on reset (8f81456)

Timing issues between requesting group deletion and GitLab enacting that deletion resulted in errors while attempting to delete a user which was the sole owner of said group (see: test_groups). Pass the 'hard_delete' parameter to ensure user deletion.

• functional: Optionally keep containers running post-tests (4c475ab)

Additionally updates token creation to make use of first_or_create(), to avoid errors from the script caused by GitLab constraints preventing duplicate tokens with the same value.

• functional: Start tracking functional test coverage (f875786)

Bug Fixes

• files: Do not url-encode file paths twice (8e25cec)

Bug Fixes

• Argument type was not a tuple as expected (062f8f6)

While adding type-hints mypy flagged this as an issue. The third argument to register_custom_action is supposed to be a tuple. It was being passed as a string rather than a tuple of strings.

• Better real life token lookup example (9ef8311)

• Checking if RESTManager._from_parent_attrs is set (8224b40)

Prior to commit 3727cbd21fc40b312573ca8da56e0f6cf9577d08 RESTManager._from_parent_attrs did not exist unless it was explicitly set. But commit 3727cbd21fc40b312573ca8da56e0f6cf9577d08 set it to a default value of {}.

So the checks using hasattr() were no longer valid.

Update the checks to check if RESTManager._from_parent_attrs has a value.

• Correct ProjectFile.decode() documentation (b180baf)

ProjectFile.decode() returns 'bytes' and not 'str'.

Update the method's doc-string and add a type-hint.

ProjectFile.decode() returns the result of a call to base64.b64decode()

The docs for that function state it returns 'bytes': https://docs.python.org/3/library/base64.html#base64.b64decode

Fixes: #1403

• Correct some type-hints in gitlab/mixins.py (8bd3124)

Commit baea7215bbbe07c06b2ca0f97a1d3d482668d887 introduced type-hints for gitlab/mixins.py.

After starting to add type-hints to gitlab/v4/objects/users.py discovered a few errors.

Main error was using '=' instead of ':'. For example: _parent = Optional[...] should be _parent: Optional[...]

Resolved those issues.

• Extend wait timeout for test_delete_user() (19fde8e)

Have been seeing intermittent failures of the test_delete_user() functional test. Have made the following changes to hopefully resolve the issue and if it still fails to know better why the failure occurred.

• Extend the wait timeout for test_delete_user() from 30 to 60 tries of 0.5 seconds each.

• Modify wait_for_sidekiq() to return True if sidekiq process terminated. Return False if the timeout expired.

• Modify wait_for_sidekiq() to loop through all processes instead of assuming there is only one process. If all processes are not busy then return.

• Modify wait_for_sidekiq() to sleep at least once before checking for processes being busy.

• Check for True being returned in test_delete_user() call to wait_for_sidekiq()

• Handle tags like debian/2%2.6-21 as identifiers (b4dac5c)

Git refnames are relatively free-form and can contain all sort for special characters, not just / and #, see http://git-scm.com/docs/git-check-ref-format

In particular, Debian's DEP-14 standard for storing packaging in git repositories mandates the use of the % character in tags in some cases like debian/2%2.6-21.

Unfortunately python-gitlab currently only escapes / to %2F and in some cases # to %23. This means that when using the commit API to retrieve information about the debian/2%2.6-21 tag only the slash is escaped before being inserted in the URL path and the % is left untouched, resulting in something like /api/v4/projects/123/repository/commits/debian%2F2%2.6-21. When urllib3 seees that it detects the invalid % escape and then urlencodes the whole string, resulting in /api/v4/projects/123/repository/commits/debian%252F2%252.6-21, where the original / got escaped twice and produced %252F.

To avoid the issue, fully urlencode identifiers and parameters to avoid the urllib3 auto-escaping in all cases.

Signed-off-by: Emanuele Aina emanuele.aina@collabora.com

• Handling config value in _get_values_from_helper (9dfb4cd)

• Honor parameter value passed (c2f8f0e)

Gitlab allows setting the defaults for MR to delete the source. Also the inline help of the CLI suggest that a boolean is expected, but no matter what value you set, it will always delete.

• Let the homedir be expanded in path of helper (fc7387a)

• Linting issues and test (b04dd2c)

• Make secret helper more user friendly (fc2798f)

• Only add query_parameters to GitlabList once (ca2c3c9)

Fixes #1386

• Only append kwargs as query parameters (b9ecc9a)

Some arguments to http_request were being read from kwargs, but kwargs is where this function creates query parameters from, by default. In the absence of a query_parameters param, the function would construct URLs with query parameters such as retry_transient_errors=True despite those parameters having no meaning to the API to which the request was sent.

This change names those arguments that are specific to http_request so that they do not end up as query parameters read from kwargs.

• Remove duplicate class definitions in v4/objects/users.py (7c4e625)

The classes UserStatus and UserStatusManager were each declared twice. Remove the duplicate declarations.

• Test_update_group() dependency on ordering (e78a8d6)

Since there are two groups we can't depend on the one we changed to always be the first one returned.

Instead fetch the group we want and then test our assertion against that group.

• Tox pep8 target, so that it can run (f518e87)

Previously running the pep8 target would fail as flake8 was not installed.

Now install flake8 for the pep8 target.

NOTE: Running the pep8 target fails as there are many warnings/errors.

But it does allow us to run it and possibly work on reducing these warnings/errors in the future.

In addition, add two checks to the ignore list as black takes care of formatting. The two checks added to the ignore list are: * E501: line too long * W503: line break before binary operator

• Undefined name errors (48ec9e0)

Discovered that there were some undefined names.

• Update doc for token helper (3ac6fa1)

• Update user's bool data and avatar (3ba27ff)

If we want to update email, avatar and do not send email confirmation change (skip_reconfirmation = True), MultipartEncoder will try to encode everything except None and bytes. So it tries to encode bools. Casting bool's values to their stringified int representation fix it.

• Wrong variable name (15ec41c)

Discovered this when I ran flake8 on the file. Unfortunately I was the one who introduced this wrong variable name :(

• objects: Add single get endpoint for instance audit events (c3f0a6f)

• types: Prevent dir from producing duplicates (5bf7525)

Chores

• Add _create_attrs & _update_attrs to RESTManager (147f05d)

Add the attributes: _create_attrs and _update_attrs to the RESTManager class. This is so that we stop using getattr() if we don't need to.

This also helps with type-hints being available for these attributes.

• Add additional type-hints for gitlab/base.py (ad72ef3)

Add type-hints for the variables which are set via self.dict

mypy doesn't see them when they are assigned via self.dict. So declare them in the class definition.

• Add and fix some type-hints in gitlab/client.py (8837207)

Was able to figure out better type-hints for gitlab/client.py

• Add test (f8cf1e1)

• Add type hints to gitlab/base.py (3727cbd)

• Add type hints to gitlab/base.py:RESTManager (9c55593)

Add some additional type hints to gitlab/base.py

• Add type hints to gitlab/utils.py (acd9294)

• Add type-hints for gitlab/mixins.py (baea721)

• Added type-hints for gitlab/mixins.py * Changed use of filter with a lambda expression to list-comprehension. mypy was not able to understand the previous code. Also list-comprehension is better :)

• Add type-hints to gitlab/cli.py (10b7b83)

• Add type-hints to gitlab/client.py (c9e5b4f)

Adding some initial type-hints to gitlab/client.py

• Add type-hints to gitlab/config.py (213e563)

• Add type-hints to gitlab/const.py (a10a777)

• Bump version to 2.7.0 (34c4052)

• Del 'import *' in gitlab/v4/objects/project_access_tokens.py (9efbe12)

Remove usage of 'import *' in gitlab/v4/objects/project_access_tokens.py.

• Disallow incomplete type defs (907634f)

Don't allow a partially annotated function definition. Either none of the function is annotated or all of it must be.

Update code to ensure no-more partially annotated functions.

Update gitlab/cli.py with better type-hints. Changed Tuple[Any, ...] to Tuple[str, ...]

• Explicitly import gitlab.v4.objects/cli (233b79e)

As we only support the v4 Gitlab API, explicitly import gitlab.v4.objects and gitlab.v4.clie instead of dynamically importing it depending on the API version.

This has the added benefit of mypy being able to type check the Gitlab init() function as currently it will fail if we enable type checking of init() it will fail.

Also, this also helps by not confusing tools like pyinstaller/cx_freeze with dynamic imports so you don't need hooks for standalone executables. And according to https://docs.gitlab.com/ee/api/,

"GraphQL co-exists with the current v4 REST API. If we have a v5 API, this should be a compatibility layer on top of GraphQL."

• Fix E711 error reported by flake8 (630901b)

E711: Comparison to none should be 'if cond is none:'

https://www.flake8rules.com/rules/E711.html

• Fix E712 errors reported by flake8 (83670a4)

E712: Comparison to true should be 'if cond is true:' or 'if cond:'

https://www.flake8rules.com/rules/E712.html

• Fix E741/E742 errors reported by flake8 (380f227)

Fixes to resolve errors for: https://www.flake8rules.com/rules/E741.html Do not use variables named 'I', 'O', or 'l' (E741)

https://www.flake8rules.com/rules/E742.html Do not define classes named 'I', 'O', or 'l' (E742)

• Fix F401 errors reported by flake8 (ff21eb6)

F401: Module imported but unused

https://www.flake8rules.com/rules/F401.html

• Fix F841 errors reported by flake8 (40f4ab2)

Local variable name is assigned to but never used

https://www.flake8rules.com/rules/F841.html

• Fix package file test naming (8c80268)

• Fix typo in mr events (c5e6fb3)

• Have _create_attrs & _update_attrs be a namedtuple (aee1f49)

Convert _create_attrs and _update_attrs to use a NamedTuple (RequiredOptional) to help with code readability. Update all code to use the NamedTuple.

• Import audit events in objects (35a190c)

• Improve type-hints for gitlab/base.py (cbd43d0)

Determined the base class for obj_cls and adding type-hints for it.

• Make _types always present in RESTManager (924f83e)

We now create _types = {} in RESTManager class.

By making _types always present in RESTManager it makes the code simpler. We no longer have to do: types = getattr(self, "_types", {})

And the type checker now understands the type.

• Make lint happy (7a7c9fd)

• Make lint happy (b5f43c8)

• Make lint happy (732e49c)

• Make ListMixin._list_filters always present (8933113)

Always create ListMixin._list_filters attribute with a default value of tuple().

This way we don't need to use hasattr() and we will know the type of the attribute.

• Make RESTObject._short_print_attrs always present (6d55120)

Always create RESTObject._short_print_attrs with a default value of None.

This way we don't need to use hasattr() and we will know the type of the attribute.

• Put assert statements inside 'if TYPE_CHECKING:' (b562458)

To be safe that we don't assert while running, put the assert statements, which are used by mypy to check that types are correct, inside an 'if TYPE_CHECKING:' block.

Also, instead of asserting that the item is a dict, instead assert that it is not a requests.Response object. Theoretically the JSON could return as a list or dict, though at this time we are assuming a dict.

• Remove import of gitlab.utils from init.py (39b9183)

Initially when extracting out the gitlab/client.py code we tried to remove this but functional tests failed.

Later we fixed the functional test that was failing, so now remove the unneeded import.

• Remove Python 2 code (b5d4e40)

httplib is a Python 2 library. It was renamed to http.client in Python 3.

https://docs.python.org/2.7/library/httplib.html

• Remove unused ALLOWED_KEYSET_ENDPOINTS variable (3d5d5d8)

The variable ALLOWED_KEYSET_ENDPOINTS was added in commit f86ef3bbdb5bffa1348a802e62b281d3f31d33ad.

Then most of that commit was removed in commit e71fe16b47835aa4db2834e98c7ffc6bdec36723, but ALLOWED_KEYSET_ENDPOINTS was missed.

• Remove unused function _construct_url() (009d369)

The function _construct_url() was used by the v3 API. All usage of the function was removed in commit fe89b949922c028830dd49095432ba627d330186

• Remove unused function sanitize_parameters() (443b934)

The function sanitize_parameters() was used when the v3 API was in use. Since v3 API support has been removed there are no more users of this function.

• Remove usage of 'from ... import *' (c83eaf4)

In gitlab/v4/objects/*.py remove usage of: * from gitlab.base import * * from gitlab.mixins import *

Change them to: * from gitlab.base import CLASS_NAME * from gitlab.mixins import CLASS_NAME

Programmatically update code to explicitly import needed classes only.

After the change the output of: $ flake8 gitlab/v4/objects/*py | grep 'REST|Mixin'

Is empty. Before many messages about unable to determine if it was a valid name.

• Remove usage of 'from ... import *' in client.py (bf0c8c5)

In gitlab/client.py remove usage of: * from gitlab.const import * * from gitlab.exceptions import *

Change them to: * import gitlab.const * import gitlab.exceptions

Update code to explicitly reference things in gitlab.const and gitlab.exceptions

A flake8 run no longer lists any undefined variables. Before it listed possible undefined variables.

• Remove usage of getattr() (2afd18a)

Remove usage of getattr(self, "_update_uses_post", False)

Instead add it to class and set default value to False.

Add a tests that shows it is set to True for the ProjectMergeRequestApprovalManager and ProjectApprovalManager classes.

• api: Move repository endpoints into separate module (1ed154c)

• ci: Deduplicate PR jobs (63918c3)

• config: Allow simple commands without external script (91ffb8e)

• deps: Update dependency docker-compose to v1.28.3 (2358d48)

• deps: Update dependency docker-compose to v1.28.4 (8938484)

• deps: Update dependency docker-compose to v1.28.5 (f4ab558)

• deps: Update dependency docker-compose to v1.28.6 (46b05d5)

• deps: Update dependency docker-compose to v1.29.1 (a89ec43)

• deps: Update dependency sphinx to v3.4.3 (37c992c)

• deps: Update dependency sphinx to v3.5.0 (188c5b6)

• deps: Update dependency sphinx to v3.5.1 (f916f09)

• deps: Update dependency sphinx to v3.5.2 (9dee5c4)

• deps: Update dependency sphinx to v3.5.4 (a886d28)

• deps: Update gitlab/gitlab-ce docker tag to v13.10.0-ce.0 (5221e33)

• deps: Update gitlab/gitlab-ce docker tag to v13.10.1-ce.0 (1995361)

• deps: Update gitlab/gitlab-ce docker tag to v13.10.3-ce.0 (eabe091)

• deps: Update gitlab/gitlab-ce docker tag to v13.11.0-ce.0 (711896f)

• deps: Update gitlab/gitlab-ce docker tag to v13.11.1-ce.0 (3088714)

• deps: Update gitlab/gitlab-ce docker tag to v13.8.2-ce.0 (7c12038)

• deps: Update gitlab/gitlab-ce docker tag to v13.8.3-ce.0 (e6c20f1)

• deps: Update gitlab/gitlab-ce docker tag to v13.8.4-ce.0 (832cb88)

• deps: Update gitlab/gitlab-ce docker tag to v13.9.0-ce.0 (3aef19c)

• deps: Update gitlab/gitlab-ce docker tag to v13.9.1-ce.0 (f6fd995)

• deps: Update gitlab/gitlab-ce docker tag to v13.9.2-ce.0 (933ba52)

• deps: Update gitlab/gitlab-ce docker tag to v13.9.3-ce.0 (2ddf45f)

• deps: Update gitlab/gitlab-ce docker tag to v13.9.4-ce.0 (939f769)

• deps: Update precommit hook alessandrojcm/commitlint-pre-commit-hook to v4 (505a8b8)

• deps: Update wagoid/commitlint-github-action action to v3 (b3274cf)

• objects: Make Project refreshable (958a6aa)

Helps getting the real state of the project from the server.

• objects: Remove noisy deprecation warning for audit events (2953642)

It's mostly an internal thing anyway and can be removed in 3.0.0

• tests: Remove unused URL segment (66f0b6c)

Documentation

• Add docs and examples for custom user agent (a69a214)

• Add information about the gitter community (6ff67e7)

Add a section in the README.rst about the gitter community. The badge already exists and is useful but very easy to miss.

• Change travis-ci badge to githubactions (2ba5ba2)

• api: Add examples for resource state events (4d00c12)

• api: Add release links API docs (36d65f0)

Features

• Add an initial mypy test to tox.ini (fdec039)

Add an initial mypy test to test gitlab/base.py and gitlab/init.py

• Add personal access token API (2bb16fa)

See: https://docs.gitlab.com/ee/api/personal_access_tokens.html

• Add project audit endpoint (6660dbe)

• Add ProjectPackageFile (b9d469b)

Add ProjectPackageFile and the ability to list project package package_files.

Fixes #1372

• Import from bitbucket server (ff3013a)

I'd like to use this libary to automate importing Bitbucket Server repositories into GitLab. There is a GitLab API endpoint to do this, but it is not exposed through this library.

• Add an import_bitbucket_server method to the ProjectManager. This method calls this GitLab API endpoint: https://docs.gitlab.com/ee/api/import.html#import-repository-from-bitbucket-server * Modify import_gitlab method docstring for python3 compatibility * Add a skipped stub test for the existing import_github method

• Option to add a helper to lookup token (8ecf559)

• api,cli: Make user agent configurable (4bb201b)

• issues: Add missing get verb to IssueManager (f78ebe0)

• objects: Add Release Links API support (28d7518)

• objects: Add support for group audit events API (2a0fbdf)

• objects: Add support for resource state events API (d4799c4)

• projects: Add project access token api (1becef0)

• users: Add follow/unfollow API (e456869)

Refactoring

• Move Gitlab and GitlabList to gitlab/client.py (53a7645)

Move the classes Gitlab and GitlabList from gitlab/init.py to the newly created gitlab/client.py file.

Update one test case that was depending on requests being defined in gitlab/init.py

• api: Explicitly export classes for star imports (f05c287)

• objects: Move instance audit events where they belong (48ba88f)

• v4: Split objects and managers per API resource (a5a48ad)

Testing

• Don't add duplicate fixture (5d94846)

Co-authored-by: Nejc Habjan hab.nejc@gmail.com

• api: Add functional test for release links API (ab2a1c8)

• api,cli: Add tests for custom user agent (c5a37e7)

• object: Add test for dir duplicates (a8e591f)

• objects: Add tests for resource state events (10225cf)

• objects: Add unit test for instance audit events (84e3247)

Bug Fixes

• Docs changed using the consts (650b65c)

• Typo (9baa905)

• api: Add missing runner access_level param (92669f2)

• api: Use RetrieveMixin for ProjectLabelManager (1a14395)

Allows to get a single label from a project, which was missing before even though the GitLab API has the ability to.

• base: Really refresh object (e1e0d8c)

This fixes and error, where deleted attributes would not show up

Fixes #1155

• cli: Add missing args for project lists (c73e237)

• cli: Write binary data to stdout buffer (0733ec6)

Chores

• Added constants for search API (8ef53d6)

• Added docs for search scopes constants (7565bf0)

• Allow overriding docker-compose env vars for tag (27109ca)

• Apply suggestions (65ce026)

• Move .env into docker-compose dir (55cbd1c)

• Offically support and test 3.9 (62dd07d)

• Remove unnecessary random function (d4ee0a6)

• Simplified search scope constants (16fc048)

• Use helper fixtures for test directories (40ec2f5)

• ci: Add .readthedocs.yml (0ad441e)

• ci: Add coverage and docs jobs (2de64cf)

• ci: Add pytest PR annotations (8f92230)

• ci: Fix copy/paste oopsie (c6241e7)

• ci: Fix typo in matrix (5e1547a)

• ci: Force colors in pytest runs (1502079)

• ci: Pin docker-compose install for tests (1f7a2ab)

This ensures python-dotenv with expected behavior for .env processing

• ci: Pin os version (cfa27ac)

• ci: Reduce renovate PR noise (f4d7a55)

• ci: Replace travis with Actions (8bb73a3)

• cli: Remove python2 code (1030e0a)

• deps: Pin dependencies (14d8f77)

• deps: Pin dependency requests-toolbelt to ==0.9.1 (4d25f20)

• deps: Update dependency requests to v2.25.1 (9c2789e)

• deps: Update gitlab/gitlab-ce docker tag to v13.3.3-ce.0 (667bf01)

• deps: Update gitlab/gitlab-ce docker tag to v13.3.4-ce.0 (e94c4c6)

• deps: Update gitlab/gitlab-ce docker tag to v13.3.5-ce.0 (c88d870)

• deps: Update gitlab/gitlab-ce docker tag to v13.3.6-ce.0 (57b5782)

• deps: Update gitlab/gitlab-ce docker tag to v13.4.3-ce.0 (bc17889)

• deps: Update gitlab/gitlab-ce docker tag to v13.5.0-ce.0 (fc205cc)

• deps: Update gitlab/gitlab-ce docker tag to v13.5.1-ce.0 (348e860)

• deps: Update gitlab/gitlab-ce docker tag to v13.5.2-ce.0 (4a6831c)

• deps: Update gitlab/gitlab-ce docker tag to v13.5.3-ce.0 (d1b0b08)

• deps: Update gitlab/gitlab-ce docker tag to v13.5.4-ce.0 (265dbbd)

• deps: Update gitlab/gitlab-ce docker tag to v13.8.1-ce.0 (9854d6d)

• deps: Update python docker tag to v3.9 (1fc65e0)

• docs: Always edit the file directly on master (35e43c5)

There is no way to edit the raw commit

• test: Remove hacking dependencies (9384493)

Documentation

• Add Project Merge Request approval rule documentation (449fc26)

• Clean up grammar and formatting in documentation (aff9bc7)

• cli: Add auto-generated CLI reference (6c21fc8)

• cli: Add example for job artifacts download (375b29d)

• cli: Use inline anonymous references for external links (f2cf467)

There doesn't seem to be an obvious way to use an alias for identical text labels that link to different targets. With inline links we can work around this shortcoming. Until we know better.

• cli-usage: Fixed term (d282a99)

• groups: Add example for creating subgroups (92eb4e3)

• issues: Add admin, project owner hint (609c03b)

Closes #1101

• projects: Correct fork docs (54921db)

Closes #1126

• readme: Also add hint to delete gitlab-runner-test (8894f2d)

Otherwise the whole testsuite will refuse to run

• readme: Update supported Python versions (20b1e79)

Features

• Add MINIMAL_ACCESS constant (49eb3ca)

A "minimal access" access level was introduced in GitLab 13.5.

• Added support for pipeline bridges (05cbdc2)

• Adds support for project merge request approval rules (#1199, c6fbf39)

• Support multipart uploads (2fa3004)

• Unit tests added (f37ebf5)

• api: Add support for user identity provider deletion (e78e121)

• api: Added wip filter param for merge requests (d6078f8)

• api: Added wip filter param for merge requests (aa6e80d)

• tests: Test label getter (a41af90)

Refactoring

• tests: Split functional tests (61e43eb)

Testing

• Add test_project_merge_request_approvals.py (9f6335f)

• Add unit tests for badges API (2720b73)

• Add unit tests for resource label events API (e9a211c)

• Ignore failing test for now (4b4e253)

• cli: Add test for job artifacts download (f4e7950)

• env: Replace custom scripts with pytest and docker-compose (79489c7)

Bug Fixes

• Implement Gitlab's behavior change for owned=True (9977799)

• Tests fail when using REUSE_CONTAINER option (0078f89)

Fixes #1146

• Wrong reconfirmation parameter when updating user's email (b5c267e)

Since version 10.3 (and later), param to not send (re)confirmation when updating an user is skip_reconfirmation (and not skip_confirmation).

See:

• https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15175?tab= * https://docs.gitlab.com/11.11/ee/api/users.html#user-modification * https://docs.gitlab.com/ee/api/users.html#user-modification

Chores

• Bump python-gitlab to 2.5.0 (56fef01)

• Make latest black happy with existing code (6961479)

• Make latest black happy with existing code (4039c8c)

• Make latest black happy with existing code (d299753)

• Remove remnants of python2 imports (402566a)

• Remove unnecessary import (f337b7a)

• Run unittest2pytest on all unit tests (11383e7)

• Update tools dir for latest black version (c2806d8)

• Update tools dir for latest black version (f245ffb)

• ci: Pin gitlab-ce version for renovate (cb79fb7)

• ci: Use fixed black version (9565684)

• deps: Update gitlab/gitlab-ce docker tag to v13.3.2-ce.0 (9fd778b)

• deps: Update python docker tag to v3.8 (a8070f2)

• env: Add pre-commit and commit-msg hooks (82070b2)

• test: Use pathlib for paths (5a56b6b)

Documentation

• Additional project file delete example (9e94b75)

Showing how to delete without having to pull the file

• api: Add example for latest pipeline job artifacts (d20f022)

• cli: Add examples for group-project list (af86dcd)

• packages: Add examples for Packages API and cli usage (a47dfcd)

• variables: Add docs for instance-level variables (ad4b87c)

Features

• Add share/unshare group with group (7c6e541)

• Add support to resource milestone events (88f8cc7)

Fixes #1154

• api: Add endpoint for latest ref artifacts (b7a07fc)

• api: Add support for instance variables (4492fc4)

• api: Add support for Packages API (71495d1)

Refactoring

• Rewrite unit tests for objects with responses (204782a)

• Split unit tests by GitLab API resources (76b2cad)

• Turn objects module into a package (da8af6f)

Testing

• Add unit tests for resource milestone events API (1317f4b)

Fixes #1154

• api: Add tests for variables API (66d108d)

• packages: Add tests for Packages API (7ea178b)

Bug Fixes

• Add masked parameter for variables command (b6339bf)

• Do not check if kwargs is none (a349b90)

Co-authored-by: Traian Nedelea tron1point0@pm.me

• Make query kwargs consistent between call in init and next (72ffa01)

• Pass kwargs to subsequent queries in gitlab list (1d011ac)

• merge: Parse arguments as query_data (878098b)

Chores

• Bump version to 2.4.0 (1606310)

Documentation

• pipelines: Simplify download (9a068e0)

This uses a context instead of inventing your own stream handler which makes the code simpler and should be fine for most use cases.

Signed-off-by: Paul Spooren mail@aparcar.org

Features

• Added NO_ACCESS const (dab4d0a)

This constant is useful for cases where no access is granted, e.g. when creating a protected branch.

The NO_ACCESS const corresponds to the definition in https://docs.gitlab.com/ee/api/protected_branches.html

Bug Fixes

• Disable default keyset pagination (e71fe16)

Instead we set pagination to offset on the other paths

Chores

• Bump version to 2.3.1 (870e7ea)

Bug Fixes

• Use keyset pagination by default for /projects > 50000 (f86ef3b)

Workaround for https://gitlab.com/gitlab-org/gitlab/-/issues/218504. Remove this in 13.1

• config: Fix duplicate code (ee2df6f)

Fixes #1094

• project: Add missing project parameters (ad8c67d)

Chores

• Bring commit signatures up to date with 12.10 (dc382fe)

• Bump to 2.3.0 (01ff865)

• Correctly render rst (f674bf2)

• Fix typo in docstring (c20f5f1)

• Remove old builds-email service (c60e2df)

• Use pytest for unit tests and coverage (9787a40)

• ci: Add codecov integration to Travis (e230568)

• services: Update available service attributes (7afc357)

• test: Remove outdated token test (e6c9fe9)

Continuous Integration

• Add a test for creating and triggering pipeline schedule (9f04560)

• Lint fixes (930122b)

Documentation

• Update authors (ac0c84d)

• readme: Add codecov badge for master (e21b2c5)

• readme: Update test docs (6e2b1ec)

• remote_mirrors: Fix create command (bab91fe)

• remote_mirrors: Fix create command (1bb4e42)

Features

• Add group runners api (4943991)

• Add play command to project pipeline schedules (07b9988)

fix: remove version from setup

feat: add pipeline schedule play error exception

docs: add documentation for pipeline schedule play

• Allow an environment variable to specify config location (401e702)

It can be useful (especially in scripts) to specify a configuration location via an environment variable. If the "PYTHON_GITLAB_CFG" environment variable is defined, treat its value as the path to a configuration file and include it in the set of default configuration locations.

• api: Added support in the GroupManager to upload Group avatars (28eb7ea)

• services: Add project service list API (fc52221)

Can be used to list available services It was introduced in GitLab 12.7

• types: Add dir to RESTObject to expose attributes (cad134c)

Testing

• Disable test until Gitlab 13.1 (63ae77a)

• cli: Convert shell tests to pytest test cases (c4ab4f5)

• runners: Add all runners unit tests (127fa5a)

Bug Fixes

• Add missing import_project param (9b16614)

• types: Do not split single value string in ListAttribute (a26e585)

Chores

• Bump to 2.2.0 (22d4b46)

• Clean up for black and flake8 (4fede5d)

• Fix typo in allow_failures (265bbdd)

• Flatten test_import_github (b8ea96c)

• Improve and document testing against different images (98d3f77)

• Move test_import_github into TestProjectImport (a881fb7)

• Pass environment variables in tox (e06d33c)

• Remove references to python2 in test env (6e80723)

• Rename ExportMixin to DownloadMixin (847da60)

• Use raise..from for chained exceptions (#939, 79fef26)

• group: Update group_manager attributes (#1062, fa34f5e)

• chore(group): update group_manager attributes

Co-Authored-By: Nejc Habjan hab.nejc@gmail.com

• mixins: Factor out export download into ExportMixin (6ce5d1f)

Documentation

• Add docs for Group Import/Export API (8c3d744)

• Fix comment of prev_page() (b066b41)

Co-Authored-By: Nejc Habjan hab.nejc@gmail.com

• Fix comment of prev_page() (ac6b2da)

Co-Authored-By: Nejc Habjan hab.nejc@gmail.com

• Fix comment of prev_page() (7993c93)

Features

• Add create from template args to ProjectManager (f493b73)

This commit adds the v4 Create project attributes necessary to create a project from a project, instance, or group level template as documented in https://docs.gitlab.com/ee/api/projects.html#create-project

• Add support for commit GPG signature API (da7a809)

• api: Add support for Gitlab Deploy Token API (01de524)

• api: Add support for Group Import/Export API (#1037, 6cb9d92)

• api: Add support for remote mirrors API (#1056, 4cfaa2f)

Testing

• Add unit tests for Project Export (600dc86)

• Add unit tests for Project Import (f7aad5f)

• Create separate module for commit tests (8c03771)

• Move mocks to top of module (0bff713)

• Prepare base project test class for more tests (915587f)

• api: Add tests for group export/import API (e7b2d6c)

• types: Reproduce get_for_api splitting strings (#1057, babd298)

Chores

• Bump version to 2.1.2 (ad7e2bf)

Bug Fixes

• docs: Additional project statistics example (5ae5a06)

Chores

• Bump version to 2.1.1 (6c5458a)

• user: Update user attributes to 12.8 (666f880)

Bug Fixes

• Do not require empty data dict for create() (99d959f)

• Remove null values from features POST data, because it fails (1ec1816)

• Remove trailing slashes from base URL (#913, 2e396e4)

• Return response with commit data (b77b945)

• docs: Fix typo in user memberships example (33889bc)

• docs: Update to new set approvers call for # of approvers (8e0c526)

to set the # of approvers for an MR you need to use the same function as for setting the approvers id.

• docs and tests: Update docs and tests for set_approvers (2cf12c7)

Updated the docs with the new set_approvers arguments, and updated tests with the arg as well.

• objects: Add default name data and use http post (70c0cfb)

Updating approvers new api needs a POST call. Also It needs a name of the new rule, defaulting this to 'name'.

• objects: Update set_approvers function call (65ecadc)

Added a miss paramter update to the set_approvers function

• objects: Update to new gitlab api for path, and args (e512cdd)

Updated the gitlab path for set_approvers to approvers_rules, added default arg for rule type, and added arg for # of approvals required.

• projects: Correct copy-paste error (adc9101)

Chores

• Bump version to 2.1.0 (47cb58c)

• Ensure developers use same gitlab image as Travis (fab17fc)

• Fix broken requests links (b392c21)

Another case of the double slash rewrite.

Code Style

• Fix black violations (ad3e833)

Documentation

• Add reference for REQUESTS_CA_BUNDLE (37e8d5d)

• pagination: Clear up pagination docs (1609824)

Co-Authored-By: Mitar mitar.git@tnode.com

Features

• Add capability to control GitLab features per project or group (7f192b4)

• Add support for commit revert API (#991, 5298964)

• Add support for user memberships API (#1009, c313c2b)

• Use keyset pagination by default for all=True (99b4484)

• api: Add support for GitLab OAuth Applications API (4e12356)

Performance Improvements

• Prepare environment when gitlab is reconfigured (3834d9c)

Testing

• Add unit tests for base URLs with trailing slashes (32844c7)

• Add unit tests for revert commit API (d7a3066)

• Remove duplicate resp_get_project (cb43695)

• Use lazy object in unit tests (31c6562)

Chores

• Bump to 2.1.0 (a6c0660)

There are a few more features in there

• Bump version to 2.0.1 (8287a0d)

• Revert to 2.0.1 (272db26)

I've misread the tag

• user: Update user attributes (27375f6)

This also workarounds an GitLab issue, where private_profile, would reset to false if not supplied

Documentation

• auth: Remove email/password auth (c9329bb)

Bug Fixes

• projects: Adjust snippets to match the API (e104e21)

Chores

• Add PyYaml as extra require (7ecd518)

• Build_sphinx needs sphinx >= 1.7.6 (528dfab)

Stepping thru Sphinx versions from 1.6.5 to 1.7.5 build_sphinx fails. Once Sphinx == 1.7.6 build_sphinx finished.

• Bump minimum required requests version (3f78aa3)

for security reasons

• Bump to 2.0.0 (c817dcc)

Dropping support for legacy python requires a new major version

• Drop legacy python tests (af8679a)

Support dropped for: 2.7, 3.4, 3.5

• Enforce python version requirements (70176db)

Documentation

• Fix snippet get in project (3a4ff2f)

• projects: Add raw file download docs (939e9d3)

Fixes #969

Features

• Add appearance API (4c4ac5c)

• Add autocompletion support (973cb8b)

• Add global order_by option to ease pagination (d187925)

• Support keyset pagination globally (0b71ba4)

Refactoring

• Remove six dependency (9fb4645)

• Support new list filters (bded2de)

This is most likely only useful for the CLI

Testing

• Add project snippet tests (0952c55)

• Adjust functional tests for project snippets (ac0ea91)

Bug Fixes

• Ignore all parameter, when as_list=True (137d72b)

Closes #962

Chores

• Bump version to 1.15.0 (2a01326)

• ci: Use correct crane ci (18913dd)

Code Style

• Format with the latest black version (06a8050)

Documentation

• Added docs for statistics (8c84cbf)

• projects: Fix file deletion docs (1c4f1c4)

The function file.delete() requires branch argument in addition to commit_message.

Features

• Access project's issues statistics (482e57b)

Fixes #966

• Add support for /import/github (aa4d41b)

Addresses python-gitlab/python-gitlab#952

This adds a method to the ProjectManager called import_github, which maps to the /import/github API endpoint. Calling import_github will trigger an import operation from <repo_id> into <target_namespace>, using <personal_access_token> to authenticate against github. In practice a gitlab server may take many 10's of seconds to respond to this API call, so we also take the liberty of increasing the default timeout (only for this method invocation).

Unfortunately since import is a protected keyword in python, I was unable to follow the endpoint structure with the manager namespace. I'm open to suggestions on a more sensible interface.

I'm successfully using this addition to batch-import hundreds of github repositories into gitlab.

• Add variable_type to groups ci variables (0986c93)

This adds the ci variables types for create/update requests.

See https://docs.gitlab.com/ee/api/group_level_variables.html#create-variable

• Add variable_type/protected to projects ci variables (4724c50)

This adds the ci variables types and protected flag for create/update requests.

See https://docs.gitlab.com/ee/api/project_level_variables.html#create-variable

• Adding project stats (db0b00a)

Fixes #967

• Allow cfg timeout to be overrided via kwargs (e9a8289)

On startup, the timeout parameter is loaded from config and stored on the base gitlab object instance. This instance parameter is used as the timeout for all API requests (it's passed into the session object when making HTTP calls).

This change allows any API method to specify a timeout argument to **kwargs that will override the global timeout value. This was somewhat needed / helpful for the import_github method.

I have also updated the docs accordingly.

• Nicer stacktrace (697cda2)

• Retry transient HTTP errors (59fe271)

Fixes #970

Testing

• Added tests for statistics (8760efc)

• Test that all is ignored, when as_list=False (b5e88f3)

Bug Fixes

• Added missing attributes for project approvals (460ed63)

Reference: https://docs.gitlab.com/ee/api/merge_request_approvals.html#change-configuration

Missing attributes: * merge_requests_author_approval * merge_requests_disable_committers_approval

• labels: Ensure label.save() works (727f536)

Otherwise, we get: File "gitlabracadabra/mixins/labels.py", line 67, in _process_labels current_label.save() File "gitlab/exceptions.py", line 267, in wrapped_f return f(*args, **kwargs) File "gitlab/v4/objects.py", line 896, in save self._update_attrs(server_data) File "gitlab/base.py", line 131, in _update_attrs self.dict["_attrs"].update(new_attrs) TypeError: 'NoneType' object is not iterable

Because server_data is None.

• project-fork: Copy create fix from ProjectPipelineManager (516307f)

• project-fork: Correct path computation for project-fork list (44a7c27)

Chores

• Bump version to 1.14.0 (164fa4f)

• ci: Switch to crane docker image (#944, e0066b6)

Documentation

• Add project and group cluster examples (d15801d)

• Fix typo (d9871b1)

• changelog: Add notice for release-notes on Github (#938, de98e57)

• pipelines_and_jobs: Add pipeline custom variables usage example (b275eb0)

• readme: Fix Docker image reference (b9a40d8)

v1.8.0 is not available. ``` Unable to find image 'registry.gitlab.com/python-gitlab/python-gitlab:v1.8.0' locally docker: Error response from daemon: manifest for registry.gitlab.com/python-gitlab/python-gitlab:v1.8.0 not found: manifest unknown: manifest unknown.

- **snippets**: Fix snippet docs
  ([`bbaa754`](https://github.com/python-gitlab/python-gitlab/commit/bbaa754673c4a0bffece482fe33e4875ddadc2dc))

Fixes #954

### Features

- Add audit endpoint
  ([`2534020`](https://github.com/python-gitlab/python-gitlab/commit/2534020b1832f28339ef466d6dd3edc21a521260))

- Add project and group clusters
  ([`ebd053e`](https://github.com/python-gitlab/python-gitlab/commit/ebd053e7bb695124c8117a95eab0072db185ddf9))

- Add support for include_subgroups filter
  ([`adbcd83`](https://github.com/python-gitlab/python-gitlab/commit/adbcd83fa172af2f3929ba063a0e780395b102d8))


## v1.13.0 (2019-11-02)

### Bug Fixes

- **projects**: Support `approval_rules` endpoint for projects
  ([`2cef2bb`](https://github.com/python-gitlab/python-gitlab/commit/2cef2bb40b1f37b97bb2ee9894ab3b9970cef231))

The `approvers` API endpoint is deprecated [1]. GitLab instead uses the `approval_rules` API
  endpoint to modify approval settings for merge requests. This adds the functionality for
  project-level merge request approval settings.

Note that there does not exist an endpoint to 'get' a single approval rule at this moment - only
  'list'.

[1] https://docs.gitlab.com/ee/api/merge_request_approvals.html

### Chores

- Bump version to 1.13.0
  ([`d0750bc`](https://github.com/python-gitlab/python-gitlab/commit/d0750bc01ed12952a4d259a13b3917fa404fd435))

- **ci**: Update latest docker image for every tag
  ([`01cbc7a`](https://github.com/python-gitlab/python-gitlab/commit/01cbc7ad04a875bea93a08c0ce563ab5b4fe896b))

- **dist**: Add test data
  ([`3133ed7`](https://github.com/python-gitlab/python-gitlab/commit/3133ed7d1df6f49de380b35331bbcc67b585a61b))

Closes #907

- **setup**: We support 3.8 ([#924](https://github.com/python-gitlab/python-gitlab/pull/924),
  [`6048175`](https://github.com/python-gitlab/python-gitlab/commit/6048175ef2c21fda298754e9b07515b0a56d66bd))

* chore(setup): we support 3.8

* style: format with black

### Documentation

- Projects get requires id
  ([`5bd8947`](https://github.com/python-gitlab/python-gitlab/commit/5bd8947bd16398aed218f07458aef72e67f2d130))

Also, add an example value for project_id to the other projects.get() example.

- **project**: Fix group project example
  ([`e680943`](https://github.com/python-gitlab/python-gitlab/commit/e68094317ff6905049e464a59731fe4ab23521de))

GroupManager.search is removed since 9a66d78, use list(search='keyword') instead

### Features

- Add deployment creation
  ([`ca256a0`](https://github.com/python-gitlab/python-gitlab/commit/ca256a07a2cdaf77a5c20e307d334b82fd0fe861))

Added in GitLab 12.4

Fixes #917

- Add users activate, deactivate functionality
  ([`32ad669`](https://github.com/python-gitlab/python-gitlab/commit/32ad66921e408f6553b9d60b6b4833ed3180f549))

These were introduced in GitLab 12.4

- Send python-gitlab version as user-agent
  ([`c22d49d`](https://github.com/python-gitlab/python-gitlab/commit/c22d49d084d1e03426cfab0d394330f8ab4bd85a))

- **auth**: Remove deprecated session auth
  ([`b751cdf`](https://github.com/python-gitlab/python-gitlab/commit/b751cdf424454d3859f3f038b58212e441faafaf))

- **doc**: Remove refs to api v3 in docs
  ([`6beeaa9`](https://github.com/python-gitlab/python-gitlab/commit/6beeaa993f8931d6b7fe682f1afed2bd4c8a4b73))

- **test**: Unused unittest2, type -> isinstance
  ([`33b1801`](https://github.com/python-gitlab/python-gitlab/commit/33b180120f30515d0f76fcf635cb8c76045b1b42))

### Testing

- Remove warning about open files from test_todo()
  ([`d6419aa`](https://github.com/python-gitlab/python-gitlab/commit/d6419aa86d6ad385e15d685bf47242bb6c67653e))

When running unittests python warns that the json file from test_todo() was still open. Use with to
  open, read, and create encoded json data that is used by resp_get_todo().

- **projects**: Support `approval_rules` endpoint for projects
  ([`94bac44`](https://github.com/python-gitlab/python-gitlab/commit/94bac4494353e4f597df0251f0547513c011e6de))


## v1.12.1 (2019-10-07)

### Bug Fixes

- Fix not working without auth
  ([`03b7b5b`](https://github.com/python-gitlab/python-gitlab/commit/03b7b5b07e1fd2872e8968dd6c29bc3161c6c43a))


## v1.12.0 (2019-10-06)

### Bug Fixes

- **cli**: Fix cli command user-project list
  ([`c17d7ce`](https://github.com/python-gitlab/python-gitlab/commit/c17d7ce14f79c21037808894d8c7ba1117779130))

- **labels**: Don't mangle label name on update
  ([`1fb6f73`](https://github.com/python-gitlab/python-gitlab/commit/1fb6f73f4d501c2b6c86c863d40481e1d7a707fe))

- **todo**: Mark_all_as_done doesn't return anything
  ([`5066e68`](https://github.com/python-gitlab/python-gitlab/commit/5066e68b398039beb5e1966ba1ed7684d97a8f74))

### Chores

- Bump to 1.12.0
  ([`4648128`](https://github.com/python-gitlab/python-gitlab/commit/46481283a9985ae1b07fe686ec4a34e4a1219b66))

- **ci**: Build test images on tag
  ([`0256c67`](https://github.com/python-gitlab/python-gitlab/commit/0256c678ea9593c6371ffff60663f83c423ca872))

### Code Style

- Format with black
  ([`fef085d`](https://github.com/python-gitlab/python-gitlab/commit/fef085dca35d6b60013d53a3723b4cbf121ab2ae))

### Documentation

- **project**: Add submodule docs
  ([`b5969a2`](https://github.com/python-gitlab/python-gitlab/commit/b5969a2dcea77fa608cc29be7a5f39062edd3846))

- **projects**: Add note about project list
  ([`44407c0`](https://github.com/python-gitlab/python-gitlab/commit/44407c0f59b9602b17cfb93b5e1fa37a84064766))

Fixes #795

- **repository-tags**: Fix typo
  ([`3024c5d`](https://github.com/python-gitlab/python-gitlab/commit/3024c5dc8794382e281b83a8266be7061069e83e))

Closes #879

- **todo**: Correct todo docs
  ([`d64edcb`](https://github.com/python-gitlab/python-gitlab/commit/d64edcb4851ea62e72e3808daf7d9b4fdaaf548b))

### Features

- Add support for job token
  ([`cef3aa5`](https://github.com/python-gitlab/python-gitlab/commit/cef3aa51a6928338c6755c3e6de78605fae8e59e))

See https://docs.gitlab.com/ee/api/jobs.html#get-job-artifacts for usage

- **ci**: Improve functionnal tests
  ([`eefceac`](https://github.com/python-gitlab/python-gitlab/commit/eefceace2c2094ef41d3da2bf3c46a58a450dcba))

- **project**: Add file blame api
  ([`f5b4a11`](https://github.com/python-gitlab/python-gitlab/commit/f5b4a113a298d33cb72f80c94d85bdfec3c4e149))

https://docs.gitlab.com/ee/api/repository_files.html#get-file-blame-from-repository

- **project**: Implement update_submodule
  ([`4d1e377`](https://github.com/python-gitlab/python-gitlab/commit/4d1e3774706f336e87ebe70e1b373ddb37f34b45))

- **user**: Add status api
  ([`62c9fe6`](https://github.com/python-gitlab/python-gitlab/commit/62c9fe63a47ddde2792a4a5e9cd1c7aa48661492))

### Refactoring

- Remove obsolete test image
  ([`a14c02e`](https://github.com/python-gitlab/python-gitlab/commit/a14c02ef85bd4d273b8c7f0f6bd07680c91955fa))

Follow up of #896

- Remove unused code, simplify string format
  ([`c7ff676`](https://github.com/python-gitlab/python-gitlab/commit/c7ff676c11303a00da3a570bf2893717d0391f20))

### Testing

- Re-enabled py_func_v4 test
  ([`49d84ba`](https://github.com/python-gitlab/python-gitlab/commit/49d84ba7e95fa343e622505380b3080279b83f00))

- **func**: Disable commit test
  ([`c9c76a2`](https://github.com/python-gitlab/python-gitlab/commit/c9c76a257d2ed3b394f499253d890c2dd9a01e24))

GitLab seems to be randomly failing here

- **status**: Add user status test
  ([`fec4f9c`](https://github.com/python-gitlab/python-gitlab/commit/fec4f9c23b8ba33bb49dca05d9c3e45cb727e0af))

- **submodules**: Correct test method
  ([`e59356f`](https://github.com/python-gitlab/python-gitlab/commit/e59356f6f90d5b01abbe54153441b6093834aa11))

- **todo**: Add unittests
  ([`7715567`](https://github.com/python-gitlab/python-gitlab/commit/77155678a5d8dbbf11d00f3586307694042d3227))


## v1.11.0 (2019-08-31)

### Bug Fixes

- Add project and group label update without id to fix cli
  ([`a3d0d7c`](https://github.com/python-gitlab/python-gitlab/commit/a3d0d7c1e7b259a25d9dc84c0b1de5362c80abb8))

- Remove empty dict default arguments
  ([`8fc8e35`](https://github.com/python-gitlab/python-gitlab/commit/8fc8e35c63d7ebd80408ae002693618ca16488a7))

Signed-off-by: Frantisek Lachman <flachman@redhat.com>

- Remove empty list default arguments
  ([`6e204ce`](https://github.com/python-gitlab/python-gitlab/commit/6e204ce819fc8bdd5359325ed7026a48d63f8103))

Signed-off-by: Frantisek Lachman <flachman@redhat.com>

- **projects**: Avatar uploading for projects
  ([`558ace9`](https://github.com/python-gitlab/python-gitlab/commit/558ace9b007ff9917734619c05a7c66008a4c3f0))

### Chores

- Bump package version
  ([`37542cd`](https://github.com/python-gitlab/python-gitlab/commit/37542cd28aa94ba01d5d289d950350ec856745af))

### Features

- Add methods to retrieve an individual project environment
  ([`29de40e`](https://github.com/python-gitlab/python-gitlab/commit/29de40ee6a20382c293d8cdc8d831b52ad56a657))

- Group labels with subscriptable mixin
  ([`4a9ef9f`](https://github.com/python-gitlab/python-gitlab/commit/4a9ef9f0fa26e01fc6c97cf88b2a162e21f61cce))

### Testing

- Add group label cli tests
  ([`f7f24bd`](https://github.com/python-gitlab/python-gitlab/commit/f7f24bd324eaf33aa3d1d5dd12719237e5bf9816))


## v1.10.0 (2019-07-22)

### Bug Fixes

- Convert # to %23 in URLs
  ([`14f5385`](https://github.com/python-gitlab/python-gitlab/commit/14f538501bfb47c92e02e615d0817675158db3cf))

Refactor a bit to handle this change, and add unit tests.

Closes #779

- Docker entry point argument passing
  ([`67ab637`](https://github.com/python-gitlab/python-gitlab/commit/67ab6371e69fbf137b95fd03105902206faabdac))

Fixes the problem of passing spaces in the arguments to the docker entrypoint.

Before this fix, there was virtually no way to pass spaces in arguments such as task description.

- Enable use of YAML in the CLI
  ([`ad0b476`](https://github.com/python-gitlab/python-gitlab/commit/ad0b47667f98760d6a802a9d08b2da8f40d13e87))

In order to use the YAML output, PyYaml needs to be installed on the docker image. This commit adds
  the installation to the dockerfile as a separate layer.

- Handle empty 'Retry-After' header from GitLab
  ([`7a3724f`](https://github.com/python-gitlab/python-gitlab/commit/7a3724f3fca93b4f55aed5132cf46d3718c4f594))

When requests are throttled (HTTP response code 429), python-gitlab assumed that 'Retry-After'
  existed in the response headers. This is not always the case and so the request fails due to a
  KeyError. The change in this commit adds a rudimentary exponential backoff to the 'http_request'
  method, which defaults to 10 retries but can be set to -1 to retry without bound.

- Improve pickle support
  ([`b4b5dec`](https://github.com/python-gitlab/python-gitlab/commit/b4b5decb7e49ac16d98d56547a874fb8f9d5492b))

- Pep8 errors
  ([`334f9ef`](https://github.com/python-gitlab/python-gitlab/commit/334f9efb18c95bb5df3271d26fa0a55b7aec1c7a))

Errors have not been detected by broken travis runs.

- Re-add merge request pipelines
  ([`877ddc0`](https://github.com/python-gitlab/python-gitlab/commit/877ddc0dbb664cd86e870bb81d46ca614770b50e))

- Remove decode() on error_message string
  ([`16bda20`](https://github.com/python-gitlab/python-gitlab/commit/16bda20514e036e51bef210b565671174cdeb637))

The integration tests failed because a test called 'decode()' on a string-type variable - the
  GitLabException class handles byte-to-string conversion already in its __init__. This commit
  removes the call to 'decode()' in the test.

``` Traceback (most recent call last): File "./tools/python_test_v4.py", line 801, in <module>
  assert 'Retry later' in error_message.decode() AttributeError: 'str' object has no attribute
  'decode'

• Use python2 compatible syntax for super (b08efcb)

• api: Avoid parameter conflicts with python and gitlab (4bd027a)

Provide another way to send data to gitlab with a new query_parameters argument. This parameter can be used to explicitly define the dict of items to send to the server, so that **kwargs are only used to specify python-gitlab specific parameters.

Closes #566 Closes #629

• api: Don't try to parse raw downloads (35a6d85)

http_get always tries to interpret the retrieved data if the content-type is json. In some cases (artifact download for instance) this is not the expected behavior.

This patch changes http_get and download methods to always get the raw data without parsing.

Closes #683

• api: Make *MemberManager.all() return a list of objects (d74ff50)

Fixes #699

• api: Make reset_time_estimate() work again (cb388d6)

Closes #672

• cli: Allow --recursive parameter in repository tree (7969a78)

Fixes #718 Fixes #731

• cli: Don't fail when the short print attr value is None (8d1552a)

Fixes #717 Fixes #727

• cli: Exit on config parse error, instead of crashing (6ad9da0)

• Exit and hint user about possible errors * test: adjust test cases to config missing error

• cli: Fix update value for key not working (b766203)

• cli: Print help and usage without config file (6bb4d17)

Fixes #560

• docker: Use docker image with current sources (06e8ca8)

Chores

• Add a tox job to run black (c27fa48)

Allow lines to be 88 chars long for flake8.

• Bump package version to 1.10.0 (c7c8470)

• Disable failing travis test (515aa9a)

• Move checks back to travis (b764525)

• Release tags to PyPI automatically (3133b48)

Fixes #609

• ci: Add automatic GitLab image pushes (95c9b6d)

• ci: Don't try to publish existing release (b4e818d)

• ci: Fix gitlab PyPI publish (3e37df1)

• ci: Rebuild test image, when something changed (2fff260)

• ci: Update the GitLab version in the test image (c410699)

• ci: Use reliable ci system (724a672)

• setup: Add 3.7 to supported python versions (b1525c9)

• tests: Add rate limit tests (e216f06)

Code Style

• Format with black again (22b5082)

Documentation

• Add a note for python 3.5 for file content update (ca014f8)

The data passed to the JSON serializer must be a string with python 3. Document this in the exemples.

Fix #175

• Add an example of trigger token usage (ea1eefe)

Closes #752

• Add ApplicationSettings API (ab7d794)

• Add builds-related API docs (8e6a944)

• Add deploy keys API (ea089e0)

• Add labales API (31882b8)

• Add licenses API (4540614)

• Add milestones API (7411907)

• Add missing = (391417c)

• Add missing requiredCreateAttrs (b08d74a)

• Add MR API (5614a7c)

• Add MR approvals in index (0b45afb)

• Add pipeline deletion (2bb2571)

• Add project members doc (dcf31a4)

• Commits API (07c5594)

• Crossref improvements (6f9f42b)

• Do not use the :option: markup (368017c)

• Document hooks API (b21dca0)

• Document projects API (967595f)

• Fix "required" attribute (e64d0b9)

• Fix invalid Raise attribute in docstrings (95a3fe6)

• Fork relationship API (21f48b3)

• Groups API documentation (4d871aa)

• Improve the pagination section (29e2efe)

• Issues API (41cbc32)

• Notes API (3e026d2)

• Project repository API (71a2a4f)

• Project search API (e4cd04c)

• Re-order api examples (5d149a2)

Pipelines and Jobs and Protected Branches are out of order in contents and sometimes hard to find when looking for examples.

• Remove the build warning about _static (764d3ca)

• Remove v3 support (7927663)

• Repository files API (f00340f)

• Snippets API (35b7f75)

• Start a FAQ (c305459)

• System hooks API (5c51bf3)

• Tags API (dd79eda)

• Trigger_pipeline only accept branches and tags as ref (d63748a)

Fixes #430

• api-usage: Add rate limit documentation (ad4de20)

• api-usage: Fix project group example (40a1bf3)

Fixes #798

• cli: Add PyYAML requirement notice (d29a489)

Fixes #606

• groups: Fix typo (ac2d65a)

Fixes #635

• projects: Add mention about project listings (f604b25)

Having exactly 20 internal and 5 private projects in the group spent some time debugging this issue.

Hopefully that helped: https://github.com/python-gitlab/python-gitlab/issues/93

Imho should be definitely mention about all=True parameter.

• projects: Fix typo (c6bcfe6)

• projects: Fix typo in code sample (b93f2a9)

Fixes #630

• readme: Add docs build information (6585c96)

• readme: Add more info about commitlint, code-format (286f703)

• readme: Fix six url (0bc30f8)

six URL was pointing to 404

• readme: Provide commit message guidelines (bed8e1b)

Fixes #660

• setup: Use proper readme on PyPI (6898097)

• snippets: Fix project-snippets layout (7feb97e)

Fixes #828

Features

• Add endpoint to get the variables of a pipeline (564de48)

It adds a new endpoint which was released in the Gitlab CE 11.11.

Signed-off-by: Agustin Henze tin@redhat.com

• Add mr rebase method (bc4280c)

• Add support for board update (908d79f)

Closes #801

• Add support for issue.related_merge_requests (90a3631)

Closes #794

• Added approve & unapprove method for Mergerequests (53f7de7)

Offical GitLab API supports this for GitLab EE

• Bump version to 1.9.0 (aaed448)

• Get artifact by ref and job (cda1174)

• Implement artifacts deletion (76b6e1f)

Closes #744

• Obey the rate limit (2abf9ab)

done by using the retry-after header

Fixes #166

• GitLab Update: Delete ProjectPipeline (#736, 768ce19)

• feat(GitLab Update): delete ProjectPipeline

As of Gitlab 11.6 it is now possible to delete a pipeline - https://docs.gitlab.com/ee/api/pipelines.html#delete-a-pipeline

Refactoring

• Format everything black (318d277)

• Rename MASTER_ACCESS (c38775a)

to MAINTAINER_ACCESS to follow GitLab 11.0 docs

See: https://docs.gitlab.com/ce/user/permissions.html#project-members-permissions

Testing

• Add project releases test (8ff8af0)

Fixes #762

• Always use latest version to test (82b0fc6)

• Increase speed by disabling the rate limit faster (497f56c)

• Minor test fixes (3b523f4)

• Update the tests for GitLab 11.11 (622854f)

Changes in GitLab make the functional tests fail:

• Some actions add new notes and discussions: do not use hardcoded values in related listing asserts
  • The feature flag API is buggy (errors 500): disable the tests for now