summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs(api): describe use of lower-level methodsdocs/lower-level-apiNejc Habjan2022-01-162-0/+92
|
* feat: add support for Group Access Token APIFabio Huser2022-01-092-0/+35
| | | | See https://docs.gitlab.com/ee/api/group_access_tokens.html
* docs: update project access token API reference linkFabio Huser2022-01-091-1/+1
|
* Merge pull request #1812 from python-gitlab/jlvillal/pprintNejc Habjan2022-01-091-0/+14
|\ | | | | chore: add `pprint()` and `pformat()` methods to RESTObject
| * chore: add `pprint()` and `pformat()` methods to RESTObjectJohn L. Villalovos2022-01-081-0/+14
| | | | | | | | | | This is useful in debugging and testing. As can easily print out the values from an instance in a more human-readable form.
* | docs(cli): make examples more easily navigable by generating TOCNejc Habjan2022-01-081-0/+27
| |
* | chore(docs): use admonitions consistentlyNejc Habjan2022-01-082-3/+3
|/
* chore: add temporary banner for v3Nejc Habjan2022-01-051-1/+4
|
* docs: switch to Furo and refresh introduction pagesNejc Habjan2022-01-046-248/+184
|
* chore: fix typo in MR documentationMarkus Legner2022-01-041-1/+1
|
* feat(cli): allow options from args and environment variablesNejc Habjan2022-01-021-7/+50
| | | | | | | | BREAKING-CHANGE: The gitlab CLI will now accept CLI arguments and environment variables for its global options in addition to configuration file options. This may change behavior for some workflows such as running inside GitLab CI and with certain environment variables configured.
* fix: handle situation where GitLab does not return valuesjlvillal/paginationJohn L. Villalovos2021-12-301-2/+11
| | | | | | | | | | | | | | | | If a query returns more than 10,000 records than the following values are NOT returned: x.total_pages x.total Modify the code to allow no value to be set for these values. If there is not a value returned the functions will now return None. Update unit test so no longer `xfail` https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers Closes #1686
* docs: correct documentation for updating discussion noteHailiang2021-12-251-1/+1
| | | | Closes #1777
* chore: add and document optional parameters for get MRjlvillal/rebase_in_progressJohn L. Villalovos2021-12-231-0/+8
| | | | | | | Add and document (some of the) optional parameters that can be done for a `project.merge_requests.get()` Closes #1775
* docs: rename documentation files to match names of code filesJohn L. Villalovos2021-12-233-2/+2
| | | | | | | | | Rename the merge request related documentation files to match the code files. This will make it easier to find the documentation quickly. Rename: `docs/gl_objects/mrs.rst -> `docs/gl_objects/merge_requests.rst` `docs/gl_objects/mr_approvals.rst -> `docs/gl_objects/merge_request_approvals.rst`
* feat(api): support file format for repository archiveMax Ludwig2021-12-211-0/+8
|
* docs(project): remove redundant encoding parameterShashwat Kumar2021-12-191-1/+0
|
* 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
|
View Lorry Controller Status