scim2-cli 0.2.4__tar.gz → 0.4.0__tar.gz

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-cli
-Version: 0.2.4
+Version: 0.4.0
 Summary: SCIM application development CLI
 Keywords: scim,scim2,provisioning,rfc7643,rfc7644
 Author: Yaal Coop
@@ -208,7 +208,6 @@ License:                                  Apache License
             limitations under the License.
 Classifier: Intended Audience :: Developers
 Classifier: Development Status :: 3 - Alpha
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -219,16 +218,16 @@ Classifier: Environment :: Web Environment
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
 Requires-Dist: click>=8.1.7
-Requires-Dist: scim2-client>=0.7.1
-Requires-Dist: scim2-tester[httpx]>=0.2.5
+Requires-Dist: scim2-client[httpx2]>=0.9.0
+Requires-Dist: scim2-tester>=0.4.0
 Requires-Dist: sphinx-click-rst-to-ansi-formatter>=0.1.0
-Requires-Dist: pydanclick>=0.4.0
+Requires-Dist: pydanclick>=0.5.0
 Requires-Dist: pygments>=2.18.0
-Requires-Python: >=3.10
-Project-URL: changelog, https://scim2-cli.readthedocs.io/en/latest/changelog.html
+Requires-Python: >=3.11
 Project-URL: documentation, https://scim2-cli.readthedocs.io
-Project-URL: funding, https://github.com/sponsors/python-scim
 Project-URL: repository, https://github.com/python-scim/scim2-cli
+Project-URL: changelog, https://scim2-cli.readthedocs.io/en/latest/changelog.html
+Project-URL: funding, https://github.com/sponsors/python-scim
 Description-Content-Type: text/markdown
 
 # scim2-cli
@@ -242,44 +241,24 @@ Provisioning is the action of managing a set of resources across different servi
 SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
 It allows users and groups creations, modifications and deletions to be synchronized between applications.
 
-## Installation
+## Features
 
-### Binary files
+- **CRUD Commands**: `create`, `query`, `replace` and `delete` resources from the command line
+- **Search Command**: Query resources using SCIM filters, sorting and pagination
+- **Compliance Testing**: Built-in `test` command using [scim2-tester](https://scim2-tester.readthedocs.io) to validate server RFC compliance
+- **Server Discovery**: Automatic retrieval of server schemas and resource types
+- **Dynamic CLI Options**: Command options generated from server schemas
+- **Flexible Input**: Pass attributes as CLI options or pipe JSON payloads via stdin
+- **JSON Output**: Formatted JSON responses with optional indentation control
+- **Authentication**: Custom HTTP headers support for Bearer tokens and other auth methods
 
-Binary files are available on the [releases page](https://github.com/python-scim/scim2-cli/releases).
-
-### Python package
-
-scim2-cli is published on the [PyPI repository](https://pypi.org/project/scim2-cli).
-You can install it with your favourite python package manager.
-
-```shell
-pip install scim2-cli
-```
-
-### From sources
-
-To run scim2-cli from the sources, [uv is needed](https://docs.astral.sh/uv/getting-started/installation/) for development:
-
-```shell
-git clone https://github.com/python-scim/scim2-cli.git
-cd scim2-cli
-uv sync
-```
-
-Then, it can be launched directly as a Python script:
+## Installation
 
-```shell
-uv run scim2 --help
+```console
+$ curl -LsSf uvx.sh/scim2-cli/install.sh | sh
 ```
 
-Or you can build a single file binary from the sources:
-
-```shell
-uv sync --group bundle
-uv run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
-./dist/scim2 --help
-```
+Check the [installation documentation](https://scim2-cli.readthedocs.io/en/latest/installation.html) for other methods.
 
 ## Usage
 
@@ -287,7 +266,7 @@ Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html)
 
 Here is an example of resource creation:
 
-```shell
+```console
 $ 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"],
@@ -305,7 +284,7 @@ $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" create
 
 Here is an example of resource query:
 
-```shell
+```console
 $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" query user 2819c223-7f76-453a-919d-413861904646
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/README.md

@@ -9,44 +9,24 @@ Provisioning is the action of managing a set of resources across different servi
 SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
 It allows users and groups creations, modifications and deletions to be synchronized between applications.
 
-## Installation
-
-### Binary files
-
-Binary files are available on the [releases page](https://github.com/python-scim/scim2-cli/releases).
-
-### Python package
-
-scim2-cli is published on the [PyPI repository](https://pypi.org/project/scim2-cli).
-You can install it with your favourite python package manager.
-
-```shell
-pip install scim2-cli
-```
+## Features
 
-### From sources
+- **CRUD Commands**: `create`, `query`, `replace` and `delete` resources from the command line
+- **Search Command**: Query resources using SCIM filters, sorting and pagination
+- **Compliance Testing**: Built-in `test` command using [scim2-tester](https://scim2-tester.readthedocs.io) to validate server RFC compliance
+- **Server Discovery**: Automatic retrieval of server schemas and resource types
+- **Dynamic CLI Options**: Command options generated from server schemas
+- **Flexible Input**: Pass attributes as CLI options or pipe JSON payloads via stdin
+- **JSON Output**: Formatted JSON responses with optional indentation control
+- **Authentication**: Custom HTTP headers support for Bearer tokens and other auth methods
 
-To run scim2-cli from the sources, [uv is needed](https://docs.astral.sh/uv/getting-started/installation/) for development:
-
-```shell
-git clone https://github.com/python-scim/scim2-cli.git
-cd scim2-cli
-uv sync
-```
-
-Then, it can be launched directly as a Python script:
+## Installation
 
-```shell
-uv run scim2 --help
+```console
+$ curl -LsSf uvx.sh/scim2-cli/install.sh | sh
 ```
 
-Or you can build a single file binary from the sources:
-
-```shell
-uv sync --group bundle
-uv run pyinstaller --name scim2 --onefile scim2_cli/__init__.py
-./dist/scim2 --help
-```
+Check the [installation documentation](https://scim2-cli.readthedocs.io/en/latest/installation.html) for other methods.
 
 ## Usage
 
@@ -54,7 +34,7 @@ Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html)
 
 Here is an example of resource creation:
 
-```shell
+```console
 $ 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"],
@@ -72,7 +52,7 @@ $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" create
 
 Here is an example of resource query:
 
-```shell
+```console
 $ scim2 --url https://auth.example --header "Authorization: Bearer 12345" query user 2819c223-7f76-453a-919d-413861904646
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],

scim2_cli-0.4.0/pyproject.toml

@@ -0,0 +1,239 @@
+[build-system]
+requires = ["uv_build>=0.12.13,<0.13.0"]
+build-backend = "uv_build"
+
+[project]
+name = "scim2-cli"
+version = "0.4.0"
+description = "SCIM application development CLI"
+readme = "README.md"
+keywords = [
+    "scim",
+    "scim2",
+    "provisioning",
+    "rfc7643",
+    "rfc7644",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "License :: OSI Approved :: Apache Software License",
+    "Environment :: Web Environment",
+    "Programming Language :: Python",
+    "Operating System :: OS Independent",
+]
+requires-python = ">= 3.11"
+dependencies = [
+    "click>=8.1.7",
+    "scim2-client[httpx2]>=0.9.0",
+    "scim2-tester>=0.4.0",
+    "sphinx-click-rst-to-ansi-formatter>=0.1.0",
+    "pydanclick>=0.5.0",
+    "pygments>=2.18.0",
+]
+
+[[project.authors]]
+name = "Yaal Coop"
+email = "contact@yaal.coop"
+
+[project.license]
+file = "LICENSE.md"
+
+[project.urls]
+documentation = "https://scim2-cli.readthedocs.io"
+repository = "https://github.com/python-scim/scim2-cli"
+changelog = "https://scim2-cli.readthedocs.io/en/latest/changelog.html"
+funding = "https://github.com/sponsors/python-scim"
+
+[project.scripts]
+scim = "scim2_cli:cli"
+scim2 = "scim2_cli:cli"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13.0",
+    "prek>=0.1.0",
+    "pytest>=8.2.1",
+    "pytest-cov>=6.0.0",
+    "pytest-httpserver>=1.0.10",
+    "tox-uv>=1.16.0",
+]
+doc = [
+    "myst-parser>=3.0.1",
+    "shibuya>=2024.5.15",
+    "sphinx>=7.3.7",
+    "sphinx-click>=6.0.0",
+    "sphinx-design>=0.6.0",
+    "sphinx-iconify>=0.0.6",
+    "sphinx-issues>=5.0.0",
+    "sphinx-substitution-extensions>=2024.8.6",
+]
+bundle = ["pyinstaller>=6.10.0"]
+
+[tool.uv]
+exclude-newer = "14 days"
+
+[tool.uv.exclude-newer-package]
+scim2-models = false
+scim2-client = false
+scim2-server = false
+scim2-cli = false
+scim2-tester = false
+pytest-scim2-server = false
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.coverage.run]
+source = [
+    "scim2_cli",
+    "tests",
+]
+omit = [".tox/*"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "@pytest.mark.skip",
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "except ImportError",
+    "if app.debug",
+]
+
+[tool.ruff.lint]
+select = [
+    "B",
+    "D",
+    "E",
+    "F",
+    "I",
+    "UP",
+]
+ignore = [
+    "E501",
+    "E722",
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    "D203",
+    "D213",
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.codespell]
+ignore-words-list = "datas"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.tox]
+requires = ["tox>=4.19"]
+env_list = [
+    "style",
+    "py311",
+    "py312",
+    "py313",
+    "py314",
+    "minversions",
+    "doc",
+    "bundle",
+    "coverage",
+]
+
+[tool.tox.env_run_base]
+runner = "uv-venv-lock-runner"
+dependency_groups = ["dev"]
+commands = [[
+    "pytest",
+    "--showlocals",
+    "--full-trace",
+    "{posargs}",
+]]
+
+[tool.tox.env.style]
+runner = "uv-venv-runner"
+commands = [[
+    "prek",
+    "run",
+    "--all-files",
+    "--show-diff-on-failure",
+]]
+
+[tool.tox.env.minversions]
+runner = "uv-venv-runner"
+uv_resolution = "lowest-direct"
+
+[tool.tox.env.doc]
+dependency_groups = ["doc"]
+commands = [
+    [
+    "sphinx-build",
+    "-W",
+    "--keep-going",
+    "--builder",
+    "html",
+    "doc",
+    "build/sphinx/html",
+],
+    [
+    "sphinx-build",
+    "-W",
+    "--keep-going",
+    "--builder",
+    "man",
+    "doc",
+    "build/sphinx/html",
+],
+]
+
+[tool.tox.env.coverage]
+commands = [
+    [
+    "pytest",
+    "--cov",
+    "--cov-fail-under=100",
+    "--cov-report",
+    "term:skip-covered",
+    "{posargs}",
+],
+    [
+    "coverage",
+    "html",
+],
+]
+
+[tool.tox.env.bundle]
+dependency_groups = ["bundle"]
+allowlist_externals = ["./dist/scim2"]
+commands = [
+    [
+    "pyinstaller",
+    "--clean",
+    "--log-level",
+    "WARN",
+    "scim2.spec",
+],
+    [
+    "./dist/scim2",
+    "--help",
+],
+]

scim2_cli-0.2.4/pyproject.toml → scim2_cli-0.4.0/pyproject.toml.orig

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["uv_build>=0.8.9,<0.9.0"]
+requires = ["uv_build>=0.12.13,<0.13.0"]
 build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.2.4"
+version = "0.4.0"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -13,7 +13,6 @@ keywords = ["scim", "scim2", "provisioning", "rfc7643", "rfc7644"]
 classifiers = [
     "Intended Audience :: Developers",
     "Development Status :: 3 - Alpha",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -25,13 +24,13 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
-requires-python = ">= 3.10"
+requires-python = ">= 3.11"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client>=0.7.1",
-    "scim2-tester[httpx]>=0.2.5",
+    "scim2-client[httpx2]>=0.9.0",
+    "scim2-tester>=0.4.0",
     "sphinx-click-rst-to-ansi-formatter>=0.1.0",
-    "pydanclick>=0.4.0",
+    "pydanclick>=0.5.0",
     "pygments>=2.18.0",
 ]
 
@@ -46,16 +45,19 @@ dev = [
     "mypy>=1.13.0",
     "prek>=0.1.0",
     "pytest>=8.2.1",
-    "pytest-coverage>=0.0",
+    "pytest-cov>=6.0.0",
     "pytest-httpserver>=1.0.10",
     "tox-uv>=1.16.0",
 ]
 doc = [
+    "myst-parser>=3.0.1",
     "shibuya>=2024.5.15",
     "sphinx>=7.3.7",
     "sphinx-click>=6.0.0",
-    "sphinx-issues >= 5.0.0",
-    "myst-parser>=3.0.1",
+    "sphinx-design>=0.6.0",
+    "sphinx-iconify>=0.0.6",
+    "sphinx-issues>=5.0.0",
+    "sphinx-substitution-extensions>=2024.8.6",
 ]
 bundle = [
     "pyinstaller>=6.10.0",
@@ -65,6 +67,10 @@ bundle = [
 scim = "scim2_cli:cli"
 scim2 = "scim2_cli:cli"
 
+[tool.uv]
+exclude-newer = "14 days"
+exclude-newer-package = { scim2-models = false, scim2-client = false, scim2-server = false, scim2-cli = false, scim2-tester = false, pytest-scim2-server = false }
+
 [tool.uv.build-backend]
 module-root = ""
 
@@ -115,22 +121,28 @@ force-single-line = true
 [tool.ruff.format]
 docstring-code-format = true
 
+[tool.codespell]
+ignore-words-list = "datas"
+
 [tool.mypy]
 plugins = [
   "pydantic.mypy"
 ]
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 [tool.tox]
 requires = ["tox>=4.19"]
 env_list = [
     "style",
-    "py310",
     "py311",
     "py312",
     "py313",
     "py314",
     "minversions",
     "doc",
+    "bundle",
     "coverage",
 ]
 
@@ -154,8 +166,8 @@ uv_resolution = "lowest-direct"
 [tool.tox.env.doc]
 dependency_groups = ["doc"]
 commands = [
-    ["sphinx-build", "--builder", "html", "doc", "build/sphinx/html"],
-    ["sphinx-build", "--builder", "man", "doc", "build/sphinx/html"],
+    ["sphinx-build", "-W", "--keep-going", "--builder", "html", "doc", "build/sphinx/html"],
+    ["sphinx-build", "-W", "--keep-going", "--builder", "man", "doc", "build/sphinx/html"],
 ]
 
 [tool.tox.env.coverage]
@@ -163,3 +175,11 @@ commands = [
     ["pytest", "--cov", "--cov-fail-under=100", "--cov-report", "term:skip-covered", "{posargs}"],
     ["coverage", "html"],
 ]
+
+[tool.tox.env.bundle]
+dependency_groups = ["bundle"]
+allowlist_externals = ["./dist/scim2"]
+commands = [
+    ["pyinstaller", "--clean", "--log-level", "WARN", "scim2.spec"],
+    ["./dist/scim2", "--help"],
+]

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/__init__.py

@@ -2,16 +2,14 @@ import json
 import re
 
 import click
-from httpx import Client
-from scim2_client import SCIMClientError
-from scim2_client.engines.httpx import SyncSCIMClient
-from scim2_models import Group
+from httpx2 import Client
+from scim2_client.engines.httpx2 import SyncSCIMClient
 from scim2_models import ListResponse
-from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import Schema
+from scim2_models import ScimProvider
+from scim2_models import ScimProviderError
 from scim2_models import ServiceProviderConfig
-from scim2_models import User
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from scim2_cli.create import create_cli
@@ -21,49 +19,41 @@ from scim2_cli.replace import replace_cli
 from scim2_cli.search import search_cli
 from scim2_cli.test import test_cli
 from scim2_cli.utils import DOC_URL
+from scim2_cli.utils import SCIM_EXCEPTIONS
 from scim2_cli.utils import HeaderType
+from scim2_cli.utils import escape_control_characters
 from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import split_headers
 
 
-def load_config_files(
-    schemas_fd, resource_types_fd, service_provider_config_fd
-) -> tuple[
-    list[type[Resource]], list[ResourceType] | None, ServiceProviderConfig | None
-]:
-    if schemas_fd:
-        schemas_payload = json.load(schemas_fd)
-        if isinstance(schemas_payload, dict):
-            schemas_obj = ListResponse[Schema].model_validate(schemas_payload).resources
-        else:
-            schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
-        resource_models = [Resource.from_schema(schema) for schema in schemas_obj]
-
-    else:
-        resource_models = [User, Group]
-
-    if resource_types_fd:
-        resource_types_payload = json.load(resource_types_fd)
-        if isinstance(schemas_payload, dict):
-            resource_types = (
-                ListResponse[ResourceType]
-                .model_validate(resource_types_payload)
-                .resources
-            )
-        else:
-            resource_types = [
-                ResourceType.model_validate(item) for item in resource_types_payload
-            ]
-    else:
-        resource_types = None
-
-    if service_provider_config_fd:
-        spc_payload = json.load(service_provider_config_fd)
-        service_provider_config = ServiceProviderConfig.model_validate(spc_payload)
-    else:
-        service_provider_config = None
-
-    return resource_models, resource_types, service_provider_config
+def load_objects(fd, model):
+    """Read a list of objects, bare or wrapped in a ListResponse, from a JSON file."""
+    payload = json.load(fd)
+    if isinstance(payload, dict):
+        return ListResponse[model].model_validate(payload).resources or []
+    return [model.model_validate(item) for item in payload]
+
+
+def describe_server(
+    scim_client, schemas_fd, resource_types_fd, service_provider_config_fd
+) -> ScimProvider:
+    """Describe the server with the configuration files, and query it for the others."""
+    resource_types = (
+        load_objects(resource_types_fd, ResourceType)
+        if resource_types_fd
+        else scim_client.query(ResourceType).resources or []
+    )
+    schemas = (
+        load_objects(schemas_fd, Schema)
+        if schemas_fd
+        else scim_client.query(Schema).resources or []
+    )
+    config = (
+        ServiceProviderConfig.model_validate(json.load(service_provider_config_fd))
+        if service_provider_config_fd
+        else scim_client.query(ServiceProviderConfig)
+    )
+    return ScimProvider.from_discovery(schemas, resource_types, config)
 
 
 @click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
@@ -73,7 +63,7 @@ def load_config_files(
     "--header",
     multiple=True,
     type=HeaderType(),
-    help="Headers to pass in the HTTP requests. Can be passed multiple times.",
+    help="Headers to pass in the HTTP requests. Can be passed multiple times. Other users of the machine can see the command line arguments, so pass the secrets with the SCIM_CLI_HEADERS environment variable.",
     envvar="SCIM_CLI_HEADERS",
 )
 @click.option(
@@ -122,29 +112,21 @@ def cli(
     headers_dict = split_headers(header)
     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
-    )
-
-    scim_client = SyncSCIMClient(
-        client,
-        resource_models=resource_models,
-        resource_types=resource_types_obj,
-        service_provider_config=spc_obj,
-    )
+    scim_client = SyncSCIMClient(client)
     try:
-        scim_client.discover(
-            schemas=not bool(schemas),
-            resource_types=not bool(resource_types),
-            service_provider_config=not bool(service_provider_config),
+        scim_client.provider = describe_server(
+            scim_client, schemas, resource_types, service_provider_config
         )
-    except SCIMClientError as exc:
+    except (*SCIM_EXCEPTIONS, ScimProviderError) as exc:
         raise exception_to_click_error(exc) from exc
 
+    provider = scim_client.provider
     ctx.obj["client"] = scim_client
     ctx.obj["resource_models"] = {
-        re.sub(r"\[.*\]", "", resource_model.__name__.lower()): resource_model
-        for resource_model in ctx.obj["client"].resource_models
+        escape_control_characters(
+            re.sub(r"\[.*\]", "", resource_model.__name__.lower())
+        ): resource_model
+        for resource_model in map(provider.model_for, provider.resource_types)
     }
 
     if not click.get_text_stream("stdin").isatty():  # pragma: no cover

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/create.py

@@ -1,12 +1,13 @@
 import click
 from click import ClickException
 from pydanclick import from_pydantic
-from scim2_client import SCIMClientError
 from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from scim2_cli.utils import DOC_URL
+from scim2_cli.utils import SCIM_EXCEPTIONS
 from scim2_cli.utils import ModelCommand
+from scim2_cli.utils import escape_options_help
 from scim2_cli.utils import exception_to_click_error
 from scim2_cli.utils import formatted_payload
 from scim2_cli.utils import unacceptable_fields
@@ -16,7 +17,7 @@ def create_payload(client, payload, indent):
     try:
         response = client.create(payload, raise_scim_errors=False)
 
-    except SCIMClientError as scim_exc:
+    except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
@@ -75,7 +76,7 @@ def create_factory(model):
 
         create_payload(ctx.obj["client"], payload, indent)
 
-    return create_command
+    return escape_options_help(create_command)
 
 
 @click.command(

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/delete.py

@@ -1,6 +1,5 @@
 import click
 from click import ClickException
-from scim2_client import SCIMClientError
 from scim2_models import Message
 from scim2_models import Resource
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
@@ -8,6 +7,7 @@ from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 from scim2_cli.utils import exception_to_click_error
 
 from .utils import DOC_URL
+from .utils import SCIM_EXCEPTIONS
 from .utils import formatted_payload
 
 
@@ -39,7 +39,7 @@ def delete_cli(ctx, resource_type, id, indent):
     try:
         response = ctx.obj["client"].delete(resource_model, id, raise_scim_errors=False)
 
-    except SCIMClientError as scim_exc:
+    except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
     if response:

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/query.py

@@ -1,7 +1,7 @@
 import click
 from click import ClickException
-from scim2_client import SCIMClientError
 from scim2_models import ResourceType
+from scim2_models import ResponseParameters
 from scim2_models import Schema
 from scim2_models import SearchRequest
 from scim2_models import ServiceProviderConfig
@@ -10,6 +10,7 @@ from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 from scim2_cli.utils import exception_to_click_error
 
 from .utils import DOC_URL
+from .utils import SCIM_EXCEPTIONS
 from .utils import formatted_payload
 
 
@@ -73,6 +74,9 @@ def query_cli(
     - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is not set, then the request will made on the :code:`/Users` endpoint.
     - If :code:`RESOURCE_TYPE` is not set, then the request will made on the :code:`/` endpoint.
 
+    When a single resource is queried, only :code:`--attribute` and :code:`--excluded-attribute` are
+    available, as defined in `RFC7644 §3.4.1 <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_.
+
     Data passed in JSON format to stdin is sent as request arguments and all the other query arguments are ignored:
 
     .. code-block:: bash
@@ -92,10 +96,34 @@ def query_cli(
                 f"Unknown resource type '{resource_type}. Available values are: {ok_values}'"
             ) from exc
 
+    single_resource = bool(id) or resource_type is ServiceProviderConfig
+    listing_options = [
+        name
+        for name, value in (
+            ("--start-index", start_index),
+            ("--count", count),
+            ("--filter", filter),
+            ("--sort-by", sort_by),
+            ("--sort-order", sort_order),
+        )
+        if value is not None
+    ]
+    if single_resource and listing_options:
+        raise ClickException(
+            f"{', '.join(listing_options)} cannot be used when querying a single resource."
+        )
+
     if ctx.obj.get("stdin"):
         check_request_payload = False
         payload = ctx.obj.get("stdin")
 
+    elif single_resource:
+        check_request_payload = True
+        payload = ResponseParameters(
+            attributes=attribute,
+            excluded_attributes=excluded_attribute,
+        )
+
     else:
         check_request_payload = True
         payload = SearchRequest(
@@ -112,12 +140,12 @@ def query_cli(
         response = ctx.obj["client"].query(
             resource_type,
             id,
-            search_request=payload,
+            query_parameters=payload,
             check_request_payload=check_request_payload,
             raise_scim_errors=False,
         )
 
-    except SCIMClientError as scim_exc:
+    except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/replace.py

@@ -1,13 +1,14 @@
 import click
 from click import ClickException
 from pydanclick import from_pydantic
-from scim2_client import SCIMClientError
 from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
+from scim2_cli.utils import escape_options_help
 from scim2_cli.utils import exception_to_click_error
 
 from .utils import DOC_URL
+from .utils import SCIM_EXCEPTIONS
 from .utils import ModelCommand
 from .utils import formatted_payload
 from .utils import unacceptable_fields
@@ -17,7 +18,7 @@ def replace_payload(client, payload, indent):
     try:
         response = client.replace(payload, raise_scim_errors=False)
 
-    except SCIMClientError as scim_exc:
+    except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)
@@ -82,7 +83,7 @@ def replace_factory(model):
             indent,
         )
 
-    return replace_command
+    return escape_options_help(replace_command)
 
 
 @click.command(

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/search.py

@@ -1,11 +1,11 @@
 import click
-from scim2_client import SCIMClientError
 from scim2_models import SearchRequest
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from scim2_cli.utils import exception_to_click_error
 
 from .utils import DOC_URL
+from .utils import SCIM_EXCEPTIONS
 from .utils import formatted_payload
 
 
@@ -91,7 +91,7 @@ def search_cli(
             raise_scim_errors=False,
         )
 
-    except SCIMClientError as scim_exc:
+    except SCIM_EXCEPTIONS as scim_exc:
         raise exception_to_click_error(scim_exc) from scim_exc
 
     payload = formatted_payload(response.model_dump(), indent)

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/test.py

@@ -7,6 +7,7 @@ from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from .utils import DOC_URL
 from .utils import Color
+from .utils import escape_control_characters
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="test")
@@ -32,8 +33,8 @@ def test_cli(ctx, verbose, check_status_code, check_content_type):
          test
     """
     client = ctx.obj["client"]
-    client.check_status_code = check_status_code
-    client.check_content_type = check_content_type
+    client.check_response_status_codes = check_status_code
+    client.check_response_content_type = check_content_type
     results = check_server(client)
     click.echo(f"Performing a SCIM compliance check on {client.client.base_url} ...")
     success = True
@@ -43,11 +44,11 @@ def test_cli(ctx, verbose, check_status_code, check_content_type):
         else:
             status = click.style(result.status.name, fg=Color.red)
             success = False
-        click.echo(f"{status} {result.title}")
+        click.echo(f"{status} {escape_control_characters(result.title)}")
 
         if result.reason:
-            click.echo(f"  {result.reason}")
+            click.echo(f"  {escape_control_characters(result.reason)}")
             if verbose and result.data:
-                click.echo(f"  {result.data}")
+                click.echo(f"  {escape_control_characters(result.data)}")
 
     sys.exit(0 if success else 1)

{scim2_cli-0.2.4 → scim2_cli-0.4.0}/scim2_cli/utils.py

@@ -1,20 +1,28 @@
 import json
-import sys
-from enum import Enum
+import re
+from enum import StrEnum
 
 import click
+from scim2_client import SCIMClientException
+from scim2_models import SCIMException
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 DOC_URL = "https://scim2-cli.readthedocs.io/"
 INDENTATION_SIZE = 4
 
+SCIM_EXCEPTIONS = (SCIMClientException, SCIMException)
+
+CONTROL_CHARACTERS = re.compile(
+    "[\x00-\x08\x0b-\x1f\x7f-\x9f\u061c\u200e\u200f\u202a-\u202e\u2066-\u2069]"
+)
+
 
 class HeaderType(click.ParamType):
     envvar_list_splitter = ";"
     name = "HEADER"
 
 
-class Color(str, Enum):
+class Color(StrEnum):
     black = "black"
     red = "red"
     green = "green"
@@ -33,6 +41,25 @@ class Color(str, Enum):
     bright_white = "bright_white"
 
 
+def escape_control_characters(text) -> str:
+    """Replace the control characters of a text by their escaped form.
+
+    The texts coming from the server would otherwise be interpreted by the
+    terminal as escape sequences.
+    """
+    return CONTROL_CHARACTERS.sub(
+        lambda match: match.group().encode("unicode_escape").decode(), str(text)
+    )
+
+
+def escape_options_help(command):
+    """Escape the option help texts pydanclick takes from the schema descriptions."""
+    for param in command.params:
+        if param.help:
+            param.help = escape_control_characters(param.help)
+    return command
+
+
 def formatted_payload(obj, indent):
     indent = INDENTATION_SIZE if indent else False
     return json.dumps(obj, indent=indent)
@@ -111,8 +138,6 @@ def unacceptable_fields(context, model):
 
 def exception_to_click_error(exception):
     message = str(exception)
-    if sys.version_info >= (3, 11) and hasattr(
-        exception, "__notes__"
-    ):  # pragma: no cover
+    if hasattr(exception, "__notes__"):
         message += "\n" + "\n".join(exception.__notes__)
-    return click.ClickException(message)
+    return click.ClickException(escape_control_characters(message))