Skip to content

Commit

Permalink
Merge pull request #1000 from matusf/update-auth-docs
Browse files Browse the repository at this point in the history
Update auth docs
  • Loading branch information
max-wittig committed Jan 26, 2020
2 parents df485a9 + c9329bb commit 7843ace
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 8 deletions.
3 changes: 0 additions & 3 deletions docs/api-usage.rst
Expand Up @@ -23,9 +23,6 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
import os
gl = gitlab.Gitlab('http://10.0.0.1', job_token=os.environ['CI_JOB_TOKEN'])
# username/password authentication (for GitLab << 10.2)
gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t')
# anonymous gitlab instance, read-only for public resources
gl = gitlab.Gitlab('http://10.0.0.1')
Expand Down
6 changes: 1 addition & 5 deletions gitlab/__init__.py
Expand Up @@ -60,8 +60,6 @@ class Gitlab(object):
private_token (str): The user private token
oauth_token (str): An oauth token
job_token (str): A CI job token
email (str): The user email or login.
password (str): The user password (associated with email).
ssl_verify (bool|str): Whether SSL certificates should be validated. If
the value is a string, it is the path to a CA file used for
certificate validation.
Expand Down Expand Up @@ -211,9 +209,7 @@ def from_config(cls, gitlab_id=None, config_files=None):
)

def auth(self):
"""Performs an authentication.
Uses either the private token, or the email/password pair.
"""Performs an authentication using private token.
The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
success.
Expand Down

0 comments on commit 7843ace

Please sign in to comment.