Skip to content

Commit 2edd69c

Browse files
nejchnejch
committed
feat(api): default to gitlab.com if no URL given
1 parent 643454c commit 2edd69c

4 files changed

Lines changed: 21 additions & 11 deletions

File tree

‎docs/api-usage.rst‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,22 @@ python-gitlab only supports GitLab APIs v4.
77
``gitlab.Gitlab`` class
88
=======================
99

10-
To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
10+
To connect to GitLab.com or another GitLab server, create a ``gitlab.Gitlab`` object:
1111

1212
.. code-block:: python
1313
1414
import gitlab
1515
16-
# private token or personal token authentication
16+
# anonymous read-only access for public resources (GitLab.com)
17+
gl = gitlab.Gitlab()
18+
19+
# anonymous read-only access for public resources (self-hosted GitLab instance)
20+
gl = gitlab.Gitlab('http://10.0.0.1')
21+
22+
# private token or personal token authentication (GitLab.com)
23+
gl = gitlab.Gitlab(private_token='JVNSESs8EwWRx5yDxM5q')
24+
25+
# private token or personal token authentication (self-hosted GitLab instance)
1726
gl = gitlab.Gitlab('http://10.0.0.1', private_token='JVNSESs8EwWRx5yDxM5q')
1827
1928
# oauth token authentication
@@ -23,12 +32,6 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
2332
import os
2433
gl = gitlab.Gitlab('http://10.0.0.1', job_token=os.environ['CI_JOB_TOKEN'])
2534
26-
# anonymous gitlab instance, read-only for public resources
27-
gl = gitlab.Gitlab('http://10.0.0.1')
28-
29-
# Define your own custom user agent for requests
30-
gl = gitlab.Gitlab('http://10.0.0.1', user_agent='my-package/1.0.0')
31-
3235
# make an API request to create the gl.user object. This is mandatory if you
3336
# use the username/password authentication.
3437
gl.auth()

‎gitlab/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class Gitlab(object):
5252
"""Represents a GitLab server connection.
5353
5454
Args:
55-
url (str): The URL of the GitLab server.
55+
url (str): The URL of the GitLab server (defaults to https://gitlab.com).
5656
private_token (str): The user private token
5757
oauth_token (str): An oauth token
5858
job_token (str): A CI job token
@@ -70,7 +70,7 @@ class Gitlab(object):
7070

7171
def __init__(
7272
self,
73-
url,
73+
url=DEFAULT_URL,
7474
private_token=None,
7575
oauth_token=None,
7676
job_token=None,

‎gitlab/const.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
from gitlab.__version__ import __title__, __version__
1919

2020

21+
DEFAULT_URL = "https://gitlab.com"
22+
2123
NO_ACCESS = 0
2224
MINIMAL_ACCESS = 5
2325
GUEST_ACCESS = 10

‎gitlab/tests/test_gitlab.py‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import pytest
2222
from httmock import HTTMock, response, urlmatch, with_httmock # noqa
2323

24-
from gitlab import Gitlab, GitlabList, USER_AGENT
24+
from gitlab import Gitlab, GitlabList, DEFAULT_URL, USER_AGENT
2525
from gitlab.v4.objects import CurrentUser
2626

2727

@@ -128,6 +128,11 @@ def test_gitlab_token_auth(gl, callback=None):
128128
assert isinstance(gl.user, CurrentUser)
129129

130130

131+
def test_gitlab_default_url():
132+
gl = Gitlab()
133+
assert gl.url == DEFAULT_URL
134+
135+
131136
def test_gitlab_from_config(default_config):
132137
config_path = default_config
133138
Gitlab.from_config("one", [config_path])

0 commit comments

Comments
 (0)