scim2-cli 0.2.1__tar.gz → 0.2.3__tar.gz

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/.github/workflows/release.yml

@@ -16,8 +16,12 @@ jobs:
         uses: astral-sh/setup-uv@v3
         with:
           enable-cache: true
+      - name: build dist
+        run: uv sync --group bundle
       - name: build dist
         run: uv build
+      - name: build binary
+        run: uv run pyinstaller scim2.spec
       - uses: actions/upload-artifact@v4
         with:
           name: artifacts
@@ -28,8 +32,14 @@ jobs:
     name: create Github release
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: artifacts
+          path: dist
       - uses: softprops/action-gh-release@v2
-
+        with:
+          files: |
+            dist/scim2
   publish:
     name: release to pypi
     needs: build

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/.github/workflows/tests.yaml

@@ -65,3 +65,13 @@ jobs:
       - name: Install dependencies
         run: uv sync --group doc
       - run: uv run sphinx-build doc build/sphinx/html
+
+  nix:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: cachix/install-nix-action@v27
+      with:
+        github_access_token: ${{ secrets.GITHUB_TOKEN }}
+    - run: nix build
+    - run: nix flake check

scim2_cli-0.2.3/.hgignore

@@ -0,0 +1 @@
+.dotfiles/mercurial/.hgignore

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.8.1'
+    rev: 'v0.8.2'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: scim2-cli
-Version: 0.2.1
+Version: 0.2.3
 Summary: SCIM application development CLI
 Project-URL: documentation, https://scim2-cli.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-cli
@@ -208,6 +208,7 @@ License:                                  Apache License
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
+License-File: LICENSE.md
 Keywords: provisioning,rfc7643,rfc7644,scim,scim2
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Web Environment
@@ -222,9 +223,9 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.10
 Requires-Dist: click>=8.1.7
-Requires-Dist: pydanclick>=0.3.0
+Requires-Dist: pydanclick>=0.4.0
 Requires-Dist: pygments>=2.18.0
-Requires-Dist: scim2-client>=0.4.2
+Requires-Dist: scim2-client>=0.4.3
 Requires-Dist: scim2-tester[httpx]>=0.1.10
 Requires-Dist: sphinx-click-rst-to-ansi-formatter>=0.1.0
 Description-Content-Type: text/markdown

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/doc/changelog.rst

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+[0.2.3] - 2025-03-06
+--------------------
+
+Added
+^^^^^
+- Add the ``--no-verify`` parameter to skip certificate verifications. :issue:`20`
+
+[0.2.2] - 2024-12-06
+--------------------
+
+Added
+^^^^^
+- The :ref:`test` command returns 1 in case of errors.
+- Added :ref:`test` ``--dont-check-content-type`` and ``--dont-check-status-code`` options.
+
 [0.2.1] - 2024-12-04
 --------------------
 

scim2_cli-0.2.3/doc/tutorial.rst

@@ -0,0 +1,250 @@
+Tutorial
+========
+
+The :ref:`cli` command allows you to interact with a SCIM server.
+
+.. tip::
+
+   If you want to test scim2-cli with a real SCIM server, you can install and run `scim2-server <https://github.com/python-scim/scim2-server>`__:
+
+   .. code-block:: shell
+
+        $ pip install scim2-server
+        $ scim2-server
+
+   Then you have a functional SCIM server available at http://127.0.0.1:8080 that you can use to test the different commands.
+
+Basic parameters
+----------------
+
+In order to connect to a SCIM server you will need to pass the :option:`--url <scim --url>` parameter.
+You can also pass additional headers, such as authentication ones, with :option:`--header <scim --header>`.
+
+.. code-block:: shell
+
+    $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" create user --user-name "bjensen@example.com"
+    {
+        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+        "id": "2819c223-7f76-453a-919d-413861904646",
+        "userName": "bjensen@example.com",
+        "meta": {
+            "resourceType": "User",
+            "created": "2010-01-23T04:56:22Z",
+            "lastModified": "2011-05-13T04:42:34Z",
+            "version": 'W\\/"3694e05e9dff590"',
+            "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+        },
+    }
+
+However passing those parameters each time you use the command can be annoying.
+To make commands shorter, you can set those parameters once for all by using the :ref:`SCIM_CLI_URL <scim-url-scim_cli_url>` and :ref:`SCIM_CLI_HEADERS <scim-header-scim_cli_headers>` environment vars.
+
+.. code-block:: shell
+
+    $ export SCIM_CLI_URL="https://auth.example"
+    $ export SCIM_CLI_HEADERS="Authorization: Bearer 12345"
+    $ scim2 create user --user-name "bjensen@example.com"
+    {
+        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+        "id": "2819c223-7f76-453a-919d-413861904646",
+        "userName": "bjensen@example.com",
+        "meta": {
+            "resourceType": "User",
+            "created": "2010-01-23T04:56:22Z",
+            "lastModified": "2011-05-13T04:42:34Z",
+            "version": 'W\\/"3694e05e9dff590"',
+            "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+        },
+    }
+
+
+Server configuration
+--------------------
+
+Before doing anything, the CLI needs to reach the server configuration to find out which features are available,
+which resource schemas are available, and where they are located.
+
+By default the CLI will automatically discover those resources on the server, before each command is run.
+
+However you might find too time consuming to achieve all those network requests.
+You can store those data locally and reuse them for future command runs thanks to the
+:option:`--schemas <scim --schemas>`, :option:`--resource-types <scim --resource-types>` and :option:`--service-provider-config <scim --service-provider-config>` (and their corresponding environment vars :ref:`SCIM_CLI_SCHEMAS <scim-schemas-scim_cli_schemas>`, :ref:`SCIM_CLI_RESOURCE_TYPES <scim-resource_types-scim_cli_resource_types>` and :ref:`SCIM_CLI_SERVICE_PROVIDER_CONFIG <scim-service_provider_config-scim_cli_service_provider_config>`)
+
+.. code-block:: shell
+    :caption: Save the configuration resources
+
+    $ scim query schema > /tmp/schemas.json
+    $ scim query resourcetype > /tmp/resource-types.json
+    $ scim query serviceproviderconfig > /tmp/service-provider-config.json
+
+.. code-block:: shell
+    :caption: Load the cached resources
+
+    $ export SCIM_SCHEMAS=/tmp/schemas.json
+    $ export SCIM_RESOURCE_TYPES=/tmp/resource-types.json
+    $ export SCIM_SERVICE_PROVIDER_CONFIG=/tmp/service-provider-config.json
+    $ scim2 query ...
+
+Query and search resources
+--------------------------
+
+The :ref:`query` and :ref:`search` commands can be used to look for resources.
+:ref:`query` performs ag `GET` request on the resources endpoint, while :ref:`search` performs a `POST` request on the ``/.search`` endpoint.
+Both commands take similar options such as :option:`--count <scim-query.--count>` or :option:`--attributes <scim-query.--attributes>`.
+An exhaustive list of options can be found on the :doc:`reference`.
+:ref:`query` can also take a :option:`RESOURCE_TYPE <scim-query.RESOURCE_TYPE>` and a :option:`ID <scim-query.ID>` parameters.
+
+- If none are set, all the resources of the server are queried.
+
+  .. code-block:: console
+      :caption: Querying all the resources from the server.
+
+      $ scim query
+      {
+          "schemas": [
+              "urn:ietf:params:scim:api:messages:2.0:ListResponse"
+          ],
+          "totalResults": xx,
+          "startIndex": 1,
+          "itemsPerPage": 50,
+          "Resources": [...]
+      }
+- If :option:`RESOURCE_TYPE <scim-query.RESOURCE_TYPE>` is set and :option:`ID <scim-query.ID>` is unset, all the resource of the kind passed in parameter are returned.
+
+  .. code-block:: console
+      :caption: Querying all the users from the server.
+
+      $ scim query user
+      {
+          "schemas": [
+              "urn:ietf:params:scim:api:messages:2.0:ListResponse"
+          ],
+          "totalResults": xx,
+          "startIndex": 1,
+          "itemsPerPage": 50,
+          "Resources": [...]
+      }
+
+- If both options are set, the very resource with the ID are returned.
+
+  .. code-block:: console
+      :caption: Querying the user with the ID `38b044dd95624c4186f5614fca30305d`
+
+      $ scim query user 38b044dd95624c4186f5614fca30305d
+      {
+          "schemas": [
+              "urn:ietf:params:scim:schemas:core:2.0:User",
+              "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+          ],
+          "id": "38b044dd95624c4186f5614fca30305d",
+          "meta": {
+              "resourceType": "User",
+              "created": "2024-12-05T16:08:51.896646Z",
+              "lastModified": "2024-12-05T16:08:51.896646Z",
+              "location": "http://scim.example/v2/Users/38b044dd95624c4186f5614fca30305d",
+              "version": "W/\"637b1ce03c010cd55fe45b6f7be2247b5159b135\""
+          },
+          "userName": "bjensen@example.com"
+      }
+Create and replace resources
+----------------------------
+
+The :ref:`create` and :ref:`replace` commands can be used to edit resources.
+
+Options for those commands are dynamically generated, depending on the resource attributes available on the server.
+For instance, for the :class:`~scim2_models.User` resource, you have a ``--user-name`` option.
+You can have a look at the exhaustive list of options by running ``scim create user --help``.
+
+.. code-block:: console
+   :caption: Creation of an user.
+
+   $ scim create user --user-name bjensen@example.com
+   {
+        "schemas": [
+            "urn:ietf:params:scim:schemas:core:2.0:User",
+            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+        ],
+        "id": "38b044dd95624c4186f5614fca30305d",
+        "meta": {
+            "resourceType": "User",
+            "created": "2024-12-05T16:08:51.896646Z",
+            "lastModified": "2024-12-05T16:08:51.896646Z",
+            "location": "http://scim.example/v2/Users/38b044dd95624c4186f5614fca30305d",
+            "version": "W/\"637b1ce03c010cd55fe45b6f7be2247b5159b135\""
+        },
+        "userName": "bjensen@example.com"
+    }
+
+Delete resources
+----------------
+
+The :ref:`delete` command allows you to delete resources.
+
+.. code-block:: console
+   :caption: Deletion of an user.
+
+   $ scim delete user 38b044dd95624c4186f5614fca30305d
+
+Perform a SCIM compliance test
+------------------------------
+
+The :ref:`test` command runs a series of resource creation, edition and deletions to check that your server complies with the SCIM specifications.
+See the :doc:`scim2-tester documentation <scim2_tester:index>` for more details on which tests are performed.
+
+.. code-block:: console
+   :caption: SCIM compliance test
+
+    $ scim test
+    Performing a SCIM compliance check on http://localhost:8080 ...
+    SUCCESS check_service_provider_config_endpoint
+    SUCCESS check_query_all_resource_types
+    SUCCESS check_query_resource_type_by_id
+      Successfully accessed the /ResourceTypes/User endpoint.
+    SUCCESS check_query_resource_type_by_id
+      Successfully accessed the /ResourceTypes/Group endpoint.
+    SUCCESS check_access_invalid_resource_typ
+    ...
+
+JSON input
+----------
+
+scim2-cli will also read input data from the standard input.
+This can be used to send custom payloads to the SCIM server.
+
+When user with :ref:`query` and :ref:`search`, the input value must be a JSON representation of a :class:`~scim2_models.SearchRequest` object:
+
+.. code-block:: console
+   :caption: Search of an user by passing a custom payload.
+
+   $ echo '{"startIndex": 50, "count": 10}' | scim query user
+   {
+        "schemas": [
+            "urn:ietf:params:scim:api:messages:2.0:ListResponse"
+        ],
+        "totalResults": xx,
+        "startIndex": 50,
+        "itemsPerPage": 10,
+        "Resources": [...]
+    }
+
+When used with :ref:`create` and :ref:`replace`, no subcommand is needed and the endpoint is guessed from the payload.
+
+.. code-block:: console
+   :caption: Creation of an user by passing a custom payload.
+
+   $ echo '{"userName": "bjensen@example.com", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim create
+   {
+        "schemas": [
+            "urn:ietf:params:scim:schemas:core:2.0:User",
+            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+        ],
+        "id": "38b044dd95624c4186f5614fca30305d",
+        "meta": {
+            "resourceType": "User",
+            "created": "2024-12-05T16:08:51.896646Z",
+            "lastModified": "2024-12-05T16:08:51.896646Z",
+            "location": "http://scim.example/v2/Users/38b044dd95624c4186f5614fca30305d",
+            "version": "W/\"637b1ce03c010cd55fe45b6f7be2247b5159b135\""
+        },
+        "userName": "bjensen@example.com"
+    }

scim2_cli-0.2.3/flake.lock

@@ -0,0 +1,133 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1738680400,
+        "narHash": "sha256-ooLh+XW8jfa+91F1nhf9OF7qhuA/y1ChLx6lXDNeY5U=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "799ba5bffed04ced7067a91798353d360788b30d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-build-systems": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "pyproject-nix": [
+          "pyproject-nix"
+        ],
+        "uv2nix": [
+          "uv2nix"
+        ]
+      },
+      "locked": {
+        "lastModified": 1737338290,
+        "narHash": "sha256-gnXlfFEHA+/jMH7R+7y3JxrI3WfOjgBhzzJNuFW70UU=",
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "rev": "e1487e5cefda0c7990bdd2e660bee20971680e45",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "build-system-pkgs",
+        "type": "github"
+      }
+    },
+    "pyproject-nix": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1738204167,
+        "narHash": "sha256-J5M2sj3x4ocM93shScT/3Z4XWHZhwwW1NyQK+C+8Mys=",
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "rev": "0d9f4b90cee1b5c5d6c142ef22de1e246e003ccc",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "pyproject.nix",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs",
+        "pyproject-build-systems": "pyproject-build-systems",
+        "pyproject-nix": "pyproject-nix",
+        "uv2nix": "uv2nix"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "uv2nix": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "pyproject-nix": [
+          "pyproject-nix"
+        ]
+      },
+      "locked": {
+        "lastModified": 1738653454,
+        "narHash": "sha256-tAFX8mPZtZ+zVE/+bwPC3U+u5MxjpNP0gG24DG26jVs=",
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "rev": "05b0c148bc53aebc6a906b6d0ac41dde5954cd47",
+        "type": "github"
+      },
+      "original": {
+        "owner": "pyproject-nix",
+        "repo": "uv2nix",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

scim2_cli-0.2.3/flake.nix

@@ -0,0 +1,70 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+    pyproject-nix = {
+      url = "github:pyproject-nix/pyproject.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    uv2nix = {
+      url = "github:pyproject-nix/uv2nix";
+      inputs.pyproject-nix.follows = "pyproject-nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    pyproject-build-systems = {
+      url = "github:pyproject-nix/build-system-pkgs";
+      inputs.pyproject-nix.follows = "pyproject-nix";
+      inputs.uv2nix.follows = "uv2nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+      uv2nix,
+      pyproject-nix,
+      pyproject-build-systems,
+      ...
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        inherit (nixpkgs) lib;
+
+        workspace = uv2nix.lib.workspace.loadWorkspace { workspaceRoot = ./.; };
+
+        overlay = workspace.mkPyprojectOverlay {
+          sourcePreference = "wheel";
+        };
+
+        pkgs = nixpkgs.legacyPackages.${system};
+
+        python = pkgs.python312;
+
+        pythonSet =
+          (pkgs.callPackage pyproject-nix.build.packages {
+            inherit python;
+          }).overrideScope
+            (
+              lib.composeManyExtensions [
+                pyproject-build-systems.overlays.default
+                overlay
+              ]
+            );
+
+      in
+      {
+        packages.default = pythonSet.mkVirtualEnv "scim-cli-env" workspace.deps.default;
+
+        apps = {
+          default = {
+            type = "app";
+            program = "${self.packages.${system}.default}/bin/scim2";
+          };
+        };
+      }
+    );
+}

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-cli"
-version = "0.2.1"
+version = "0.2.3"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -27,10 +27,10 @@ classifiers = [
 requires-python = ">= 3.10"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client>=0.4.2",
+    "scim2-client>=0.4.3",
     "scim2-tester[httpx]>=0.1.10",
     "sphinx-click-rst-to-ansi-formatter>=0.1.0",
-    "pydanclick>=0.3.0",
+    "pydanclick>=0.4.0",
     "pygments>=2.18.0",
 ]
 

{scim2_cli-0.2.1 → scim2_cli-0.2.3}/scim2_cli/__init__.py

@@ -1,11 +1,8 @@
 import json
 import re
-from typing import Any
-from typing import TypeGuard
 
 import click
 from httpx import Client
-from pydantic import BaseModel
 from scim2_client import SCIMClientError
 from scim2_client.engines.httpx import SyncSCIMClient
 from scim2_models import Group
@@ -29,24 +26,6 @@ from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import split_headers
 
 
-# monkeypatching pydanclick until this patch is released
-# https://github.com/felix-martel/pydanclick/pull/25
-def patch_pydanclick():
-    def _is_pydantic_model(model: Any) -> TypeGuard[type[BaseModel]]:
-        """Return True if `model` is a Pydantic `BaseModel` class."""
-        try:
-            return issubclass(model, BaseModel)
-        except TypeError:
-            return False
-
-    import pydanclick.model.field_collection
-
-    pydanclick.model.field_collection._is_pydantic_model = _is_pydantic_model
-
-
-patch_pydanclick()
-
-
 def load_config_files(
     schemas_fd, resource_types_fd, service_provider_config_fd
 ) -> tuple[
@@ -97,6 +76,12 @@ def load_config_files(
     help="Headers to pass in the HTTP requests. Can be passed multiple times.",
     envvar="SCIM_CLI_HEADERS",
 )
+@click.option(
+    "--no-verify",
+    is_flag=True,
+    default=False,
+    help="Don't perform https certificate verifications.",
+)
 @click.option(
     "-s",
     "--schemas",
@@ -120,7 +105,13 @@ def load_config_files(
 )
 @click.pass_context
 def cli(
-    ctx, url: str, header: list[str], schemas, resource_types, service_provider_config
+    ctx,
+    url: str,
+    header: list[str],
+    no_verify,
+    schemas,
+    resource_types,
+    service_provider_config,
 ):
     """SCIM application development CLI."""
     ctx.ensure_object(dict)
@@ -129,7 +120,7 @@ def cli(
         raise click.ClickException("No SCIM server URL defined.")
 
     headers_dict = split_headers(header)
-    client = Client(base_url=url, headers=headers_dict)
+    client = Client(base_url=url, headers=headers_dict, verify=not no_verify)
 
     resource_models, resource_types_obj, spc_obj = load_config_files(
         schemas, resource_types, service_provider_config