summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* feat(cli): do not require config file to run CLIfeat/cli-without-config-fileNejc Habjan2021-12-131-3/+11
| | | | | | | | | | | BREAKING CHANGE: A config file is no longer needed to run the CLI. python-gitlab will default to https://gitlab.com with no authentication if there is no config file provided. python-gitlab will now also only look for configuration in the provided PYTHON_GITLAB_CFG path, instead of merging it with user- and system-wide config files. If the environment variable is defined and the file cannot be opened, python-gitlab will now explicitly fail.
* chore(api): temporarily remove topic delete endpointNejc Habjan2021-12-111-7/+0
| | | | It is not yet available upstream.
* feat(api): add support for Topics APINejc Habjan2021-12-112-0/+49
|
* feat: add delete on package_file objectSimon Hébert-Deschamps2021-12-091-1/+1
|
* Merge pull request #1709 from python-gitlab/docs/sphinx-annotationsNejc Habjan2021-12-012-1/+3
|\ | | | | docs: only use type annotations for documentation
| * chore(docs): link to main, not masterNejc Habjan2021-11-281-1/+1
| |
| * chore(docs): use builtin autodoc hintsNejc Habjan2021-11-281-1/+2
| |
| * chore(docs): load autodoc-typehints moduleNejc Habjan2021-11-281-0/+1
| |
* | Merge pull request #1702 from python-gitlab/jlvillal/attribute_helpNejc Habjan2021-12-011-0/+12
|\ \ | | | | | | chore: attempt to be more informative for missing attributes
| * | chore: attempt to be more informative for missing attributesjlvillal/attribute_helpJohn L. Villalovos2021-11-301-0/+12
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A commonly reported issue from users on Gitter is that they get an AttributeError for an attribute that should be present. This is often caused due to the fact that they used the `list()` method to retrieve the object and objects retrieved this way often only have a subset of the full data. Add more details in the AttributeError message that explains the situation to users. This will hopefully allow them to resolve the issue. Update the FAQ in the docs to add a section discussing the issue. Closes #1138
* | docs: update docs to use gitlab.const for constantsjlvillal/const_explicitJohn L. Villalovos2021-11-307-50/+50
|/ | | | Update the docs to use gitlab.const to access constants.
* Merge pull request #1712 from StingRayZA/EpicnotesNejc Habjan2021-11-271-1/+10
|\ | | | | feat(api): add support for epic notes
| * feat(api): add support for epic notesRaimund Hook2021-11-251-1/+10
| | | | | | | | | | | | Added support for notes on group epics Signed-off-by: Raimund Hook <raimund.hook@exfo.com>
* | feat: add support for `projects.groups.list()`jlvillal/project_groupsJohn L. Villalovos2021-11-261-0/+5
|/ | | | | | Add support for `projects.groups.list()` endpoint. Closes #1717
* feat: remove support for Python 3.6, require 3.7 or higherJohn L. Villalovos2021-11-231-1/+1
| | | | | | | | | | | | | | | | | | | | | Python 3.6 is End-of-Life (EOL) as of 2021-12 as stated in https://www.python.org/dev/peps/pep-0494/ By dropping support for Python 3.6 and requiring Python 3.7 or higher it allows python-gitlab to take advantage of new features in Python 3.7, which are documented at: https://docs.python.org/3/whatsnew/3.7.html Some of these new features that may be useful to python-gitlab are: * PEP 563, postponed evaluation of type annotations. * dataclasses: PEP 557 – Data Classes * importlib.resources * PEP 562, customization of access to module attributes. * PEP 560, core support for typing module and generic types. * PEP 565, improved DeprecationWarning handling BREAKING CHANGE: As of python-gitlab 3.0.0, Python 3.6 is no longer supported. Python 3.7 or higher is required.
* Merge pull request #1646 from JacobHenner/add-merge-trainsNejc Habjan2021-11-012-0/+30
|\ | | | | feat(api): add merge trains
| * feat(api): add merge trainsJacob Henner2021-10-202-0/+30
| | | | | | | | Add support for merge trains
* | feat(api): add project milestone promotionRaimund Hook2021-10-271-0/+4
| | | | | | | | | | | | Adds promotion to Project Milestones Signed-off-by: Raimund Hook <raimund.hook@exfo.com>
* | Merge pull request #1641 from JacobHenner/add-merge-request-approval-stateNejc Habjan2021-10-201-0/+7
|\ \ | | | | | | feat(api): add merge request approval state
| * | feat(api): add merge request approval stateJacob Henner2021-10-191-0/+7
| |/ | | | | | | Add support for merge request approval state
* | feat(api): add project label promotionRaimund Hook2021-10-181-0/+4
| | | | | | | | | | | | Adds a mixin that allows the /promote endpoint to be called. Signed-off-by: Raimund Hook <raimund.hook@exfo.com>
* | feat(objects): support delete package files APINejc Habjan2021-10-141-0/+7
| |
* | feat(objects): list starred projects of a userNejc Habjan2021-10-142-1/+14
| |
* | docs: fix API delete key exampleBen Gray2021-10-121-1/+1
| |
* | chore: rename `master` branch to `main`chore/master-to-mainNejc Habjan2021-10-117-25/+25
|/ | | | | BREAKING CHANGE: As of python-gitlab 3.0.0, the default branch for development has changed from `master` to `main`.
* docs(pipelines): document take_ownership methodNejc Habjan2021-10-081-0/+4
|
* Merge pull request #1616 from lmmx/patch-1Nejc Habjan2021-10-081-0/+2
|\ | | | | Document the `update` method for project variables
| * docs(api): document the update method for project variablesLouis Maddox2021-10-081-0/+2
| |
* | docs(api): clarify job token usage with auth()Axel Amigo Arnold2021-10-081-1/+4
| | | | | | | | See issue #1620
* | refactor(objects): remove deprecated branch protect methodsNejc Habjan2021-10-061-15/+2
|/ | | | | BREAKING CHANGE: remove deprecated branch protect methods in favor of the more complete protected branches API.
* docs: fix a few typosTim Gates2021-09-191-2/+2
| | | | | | | | | | | | | | | | | | | | | | | There are small typos in: - docs/gl_objects/deploy_tokens.rst - gitlab/base.py - gitlab/mixins.py - gitlab/v4/objects/features.py - gitlab/v4/objects/groups.py - gitlab/v4/objects/packages.py - gitlab/v4/objects/projects.py - gitlab/v4/objects/sidekiq.py - gitlab/v4/objects/todos.py Fixes: - Should read `treatment` rather than `reatment`. - Should read `transferred` rather than `transfered`. - Should read `registered` rather than `registred`. - Should read `occurred` rather than `occured`. - Should read `overridden` rather than `overriden`. - Should read `marked` rather than `maked`. - Should read `instantiate` rather than `instanciate`. - Should read `function` rather than `fonction`.
* feat(objects): support Create and Revoke personal access token APINejc Habjan2021-09-131-3/+29
|
* chore: clean up install docsNejc Habjan2021-09-121-7/+12
|
* docs: consolidate changelogs and remove v3 API docsNejc Habjan2021-09-127-120/+226
|
* refactor(objects): remove deprecated members.all() methodNejc Habjan2021-09-082-4/+0
| | | | | BREAKING CHANGE: remove deprecated members.all() method in favor of members_all.list()
* feat: default to gitlab.com if no URL givenNejc Habjan2021-09-082-25/+33
| | | | | BREAKING CHANGE: python-gitlab will now default to gitlab.com if no URL is given
* fix!: raise error if there is a 301/302 redirectionJohn L. Villalovos2021-09-082-2/+18
| | | | | | | | | | | | | | | | | | | | | | | | | Before we raised an error if there was a 301, 302 redirect but only from an http URL to an https URL. But we didn't raise an error for any other redirects. This caused two problems: 1. PUT requests that are redirected get changed to GET requests which don't perform the desired action but raise no error. This is because the GET response succeeds but since it wasn't a PUT it doesn't update. See issue: https://github.com/python-gitlab/python-gitlab/issues/1432 2. POST requests that are redirected also got changed to GET requests. They also caused hard to debug tracebacks for the user. See issue: https://github.com/python-gitlab/python-gitlab/issues/1477 Correct this by always raising a RedirectError exception and improve the exception message to let them know what was redirected. Closes: #1485 Closes: #1432 Closes: #1477
* feat: allow global retry_transient_errors setupKarun Japhet2021-08-291-0/+11
| | | | | | `retry_transient_errors` can now be set through the Gitlab instance and global configuration Documentation for API usage has been updated and missing tests have been added.
* chore: fix mypy pre-commit hookNejc Habjan2021-08-221-0/+0
|
* docs(mergequests): gl.mergequests.list documentation was missleadingLaurent Peuch2021-08-041-1/+5
|
* docs: add example for mr.merge_refMatej Focko2021-07-211-0/+5
| | | | Signed-off-by: Matej Focko <mfocko@redhat.com>
* docs(project): add example on getting a single project using name with namespaceLaurent Peuch2021-07-201-0/+4
|
* Merge pull request #1533 from sugonyak/add-group-hooksNejc Habjan2021-06-271-0/+40
|\ | | | | feat(api): add group hooks
| * feat(api): add group hooksIvan Sugonyak2021-06-261-0/+40
| |
* | docs(tags): remove deprecated functionsPierre Paques2021-06-261-4/+0
| |
* | docs(release): add update examplePierre Paques2021-06-261-0/+6
|/
* docs: make Gitlab class usable for intersphinxNejc Habjan2021-06-141-9/+19
|
* feat(api): add MR pipeline manager in favor of pipelines() methodNejc Habjan2021-06-131-4/+25
|
* feat: add keys endpointBen Brown2021-06-032-0/+29
|
* feat(objects): add support for Group wikis (#1484)Simon Pamies2021-06-031-4/+20
| | | feat(objects): add support for Group wikis