From 9cd86d44e804b09422b28ea7f3f611b90dd0c6fa Mon Sep 17 00:00:00 2001 From: "Andrew Speciale (@liquidz00)" Date: Fri, 2 Aug 2024 12:24:38 -0400 Subject: [PATCH 1/2] Fix typo; change to console code block to maintain consistency throughout project documentation --- docs/contributors/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributors/index.rst b/docs/contributors/index.rst index 4329efa..8717356 100644 --- a/docs/contributors/index.rst +++ b/docs/contributors/index.rst @@ -47,9 +47,9 @@ It is recommended you use a Python virtual environment for local development (se With your virtual environment active run the following from the SDK repository's directory: -.. code-block:: shell +.. code-block:: console - (.vent) % make install + (.venv) % make install This will install the package in editable mode with all dev and optional dependencies. From 318bc50c9e6b54d890fbd7d3812d7ec223f2aa88 Mon Sep 17 00:00:00 2001 From: "Andrew Speciale (@liquidz00)" Date: Fri, 2 Aug 2024 12:25:32 -0400 Subject: [PATCH 2/2] Add note to omit URL scheme when passing server to JamfProClient --- docs/user/getting_started.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst index 7250212..5be1986 100644 --- a/docs/user/getting_started.rst +++ b/docs/user/getting_started.rst @@ -37,6 +37,11 @@ Import the Jamf Pro client from the SDK: Create a client object passing in your Jamf Pro server name and a username and password: +.. note:: + + When passing your Jamf Pro server name, do not include the scheme (``https://``) as the SDK handles this automatically for you. + + >>> client = JamfProClient( ... server="jamf.my.org", ... credentials=BasicAuthProvider("oscar", "j@mf1234!")