summaryrefslogtreecommitdiff
path: root/docs/api-usage-advanced.rst
diff options
context:
space:
mode:
authorLiora Milbaum <liora@lmb.co.il>2022-12-04 11:12:13 +0200
committerGitHub <noreply@github.com>2022-12-04 10:12:13 +0100
commite88d34e38dd930b00d7bb48f0e1c39420e09fa0f (patch)
treeb0bccafd1a91f38db668e2c4d8893dc1f144e145 /docs/api-usage-advanced.rst
parent50a03017f2ba8ec3252911dd1cf0ed7df42cfe50 (diff)
downloadgitlab-e88d34e38dd930b00d7bb48f0e1c39420e09fa0f.tar.gz
feat: allow passing kwargs to Gitlab class when instantiating with `from_config` (#2392)
Diffstat (limited to 'docs/api-usage-advanced.rst')
-rw-r--r--docs/api-usage-advanced.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/api-usage-advanced.rst b/docs/api-usage-advanced.rst
index 2382b49..2b069b8 100644
--- a/docs/api-usage-advanced.rst
+++ b/docs/api-usage-advanced.rst
@@ -181,3 +181,15 @@ on your own, such as for nested API responses and ``Union`` return types. For ex
if TYPE_CHECKING:
assert isinstance(license["plan"], str)
+
+Custom session (Bring your own Session)
+---------------------------------------
+
+You can use configuration files and a custom session to create
+``gitlab.Gitlab`` objects:
+
+.. code-block:: python
+
+ gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'], session=custom_session)
+
+