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

scim2_cli-0.2.4/PKG-INFO

@@ -0,0 +1,327 @@
+Metadata-Version: 2.3
+Name: scim2-cli
+Version: 0.2.4
+Summary: SCIM application development CLI
+Keywords: scim,scim2,provisioning,rfc7643,rfc7644
+Author: Yaal Coop
+Author-email: Yaal Coop <contact@yaal.coop>
+License:                                  Apache License
+                                    Version 2.0, January 2004
+                                 http://www.apache.org/licenses/
+         
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+         
+            1. Definitions.
+         
+               "License" shall mean the terms and conditions for use, reproduction,
+               and distribution as defined by Sections 1 through 9 of this document.
+         
+               "Licensor" shall mean the copyright owner or entity authorized by
+               the copyright owner that is granting the License.
+         
+               "Legal Entity" shall mean the union of the acting entity and all
+               other entities that control, are controlled by, or are under common
+               control with that entity. For the purposes of this definition,
+               "control" means (i) the power, direct or indirect, to cause the
+               direction or management of such entity, whether by contract or
+               otherwise, or (ii) ownership of fifty percent (50%) or more of the
+               outstanding shares, or (iii) beneficial ownership of such entity.
+         
+               "You" (or "Your") shall mean an individual or Legal Entity
+               exercising permissions granted by this License.
+         
+               "Source" form shall mean the preferred form for making modifications,
+               including but not limited to software source code, documentation
+               source, and configuration files.
+         
+               "Object" form shall mean any form resulting from mechanical
+               transformation or translation of a Source form, including but
+               not limited to compiled object code, generated documentation,
+               and conversions to other media types.
+         
+               "Work" shall mean the work of authorship, whether in Source or
+               Object form, made available under the License, as indicated by a
+               copyright notice that is included in or attached to the work
+               (an example is provided in the Appendix below).
+         
+               "Derivative Works" shall mean any work, whether in Source or Object
+               form, that is based on (or derived from) the Work and for which the
+               editorial revisions, annotations, elaborations, or other modifications
+               represent, as a whole, an original work of authorship. For the purposes
+               of this License, Derivative Works shall not include works that remain
+               separable from, or merely link (or bind by name) to the interfaces of,
+               the Work and Derivative Works thereof.
+         
+               "Contribution" shall mean any work of authorship, including
+               the original version of the Work and any modifications or additions
+               to that Work or Derivative Works thereof, that is intentionally
+               submitted to Licensor for inclusion in the Work by the copyright owner
+               or by an individual or Legal Entity authorized to submit on behalf of
+               the copyright owner. For the purposes of this definition, "submitted"
+               means any form of electronic, verbal, or written communication sent
+               to the Licensor or its representatives, including but not limited to
+               communication on electronic mailing lists, source code control systems,
+               and issue tracking systems that are managed by, or on behalf of, the
+               Licensor for the purpose of discussing and improving the Work, but
+               excluding communication that is conspicuously marked or otherwise
+               designated in writing by the copyright owner as "Not a Contribution."
+         
+               "Contributor" shall mean Licensor and any individual or Legal Entity
+               on behalf of whom a Contribution has been received by Licensor and
+               subsequently incorporated within the Work.
+         
+            2. Grant of Copyright License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               copyright license to reproduce, prepare Derivative Works of,
+               publicly display, publicly perform, sublicense, and distribute the
+               Work and such Derivative Works in Source or Object form.
+         
+            3. Grant of Patent License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               (except as stated in this section) patent license to make, have made,
+               use, offer to sell, sell, import, and otherwise transfer the Work,
+               where such license applies only to those patent claims licensable
+               by such Contributor that are necessarily infringed by their
+               Contribution(s) alone or by combination of their Contribution(s)
+               with the Work to which such Contribution(s) was submitted. If You
+               institute patent litigation against any entity (including a
+               cross-claim or counterclaim in a lawsuit) alleging that the Work
+               or a Contribution incorporated within the Work constitutes direct
+               or contributory patent infringement, then any patent licenses
+               granted to You under this License for that Work shall terminate
+               as of the date such litigation is filed.
+         
+            4. Redistribution. You may reproduce and distribute copies of the
+               Work or Derivative Works thereof in any medium, with or without
+               modifications, and in Source or Object form, provided that You
+               meet the following conditions:
+         
+               (a) You must give any other recipients of the Work or
+                   Derivative Works a copy of this License; and
+         
+               (b) You must cause any modified files to carry prominent notices
+                   stating that You changed the files; and
+         
+               (c) You must retain, in the Source form of any Derivative Works
+                   that You distribute, all copyright, patent, trademark, and
+                   attribution notices from the Source form of the Work,
+                   excluding those notices that do not pertain to any part of
+                   the Derivative Works; and
+         
+               (d) If the Work includes a "NOTICE" text file as part of its
+                   distribution, then any Derivative Works that You distribute must
+                   include a readable copy of the attribution notices contained
+                   within such NOTICE file, excluding those notices that do not
+                   pertain to any part of the Derivative Works, in at least one
+                   of the following places: within a NOTICE text file distributed
+                   as part of the Derivative Works; within the Source form or
+                   documentation, if provided along with the Derivative Works; or,
+                   within a display generated by the Derivative Works, if and
+                   wherever such third-party notices normally appear. The contents
+                   of the NOTICE file are for informational purposes only and
+                   do not modify the License. You may add Your own attribution
+                   notices within Derivative Works that You distribute, alongside
+                   or as an addendum to the NOTICE text from the Work, provided
+                   that such additional attribution notices cannot be construed
+                   as modifying the License.
+         
+               You may add Your own copyright statement to Your modifications and
+               may provide additional or different license terms and conditions
+               for use, reproduction, or distribution of Your modifications, or
+               for any such Derivative Works as a whole, provided Your use,
+               reproduction, and distribution of the Work otherwise complies with
+               the conditions stated in this License.
+         
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+               any Contribution intentionally submitted for inclusion in the Work
+               by You to the Licensor shall be under the terms and conditions of
+               this License, without any additional terms or conditions.
+               Notwithstanding the above, nothing herein shall supersede or modify
+               the terms of any separate license agreement you may have executed
+               with Licensor regarding such Contributions.
+         
+            6. Trademarks. This License does not grant permission to use the trade
+               names, trademarks, service marks, or product names of the Licensor,
+               except as required for reasonable and customary use in describing the
+               origin of the Work and reproducing the content of the NOTICE file.
+         
+            7. Disclaimer of Warranty. Unless required by applicable law or
+               agreed to in writing, Licensor provides the Work (and each
+               Contributor provides its Contributions) on an "AS IS" BASIS,
+               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+               implied, including, without limitation, any warranties or conditions
+               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+               PARTICULAR PURPOSE. You are solely responsible for determining the
+               appropriateness of using or redistributing the Work and assume any
+               risks associated with Your exercise of permissions under this License.
+         
+            8. Limitation of Liability. In no event and under no legal theory,
+               whether in tort (including negligence), contract, or otherwise,
+               unless required by applicable law (such as deliberate and grossly
+               negligent acts) or agreed to in writing, shall any Contributor be
+               liable to You for damages, including any direct, indirect, special,
+               incidental, or consequential damages of any character arising as a
+               result of this License or out of the use or inability to use the
+               Work (including but not limited to damages for loss of goodwill,
+               work stoppage, computer failure or malfunction, or any and all
+               other commercial damages or losses), even if such Contributor
+               has been advised of the possibility of such damages.
+         
+            9. Accepting Warranty or Additional Liability. While redistributing
+               the Work or Derivative Works thereof, You may choose to offer,
+               and charge a fee for, acceptance of support, warranty, indemnity,
+               or other liability obligations and/or rights consistent with this
+               License. However, in accepting such obligations, You may act only
+               on Your own behalf and on Your sole responsibility, not on behalf
+               of any other Contributor, and only if You agree to indemnify,
+               defend, and hold each Contributor harmless for any liability
+               incurred by, or claims asserted against, such Contributor by reason
+               of your accepting any such warranty or additional liability.
+         
+            END OF TERMS AND CONDITIONS
+         
+            APPENDIX: How to apply the Apache License to your work.
+         
+               To apply the Apache License to your work, attach the following
+               boilerplate notice, with the fields enclosed by brackets "[]"
+               replaced with your own identifying information. (Don't include
+               the brackets!)  The text should be enclosed in the appropriate
+               comment syntax for the file format. We also recommend that a
+               file or class name and description of purpose be included on the
+               same "printed page" as the copyright notice for easier
+               identification within third-party archives.
+         
+            Copyright [yyyy] [name of copyright owner]
+         
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+         
+                http://www.apache.org/licenses/LICENSE-2.0
+         
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            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.
+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
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: License :: OSI Approved :: Apache Software License
+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: sphinx-click-rst-to-ansi-formatter>=0.1.0
+Requires-Dist: pydanclick>=0.4.0
+Requires-Dist: pygments>=2.18.0
+Requires-Python: >=3.10
+Project-URL: changelog, https://scim2-cli.readthedocs.io/en/latest/changelog.html
+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
+Description-Content-Type: text/markdown
+
+# scim2-cli
+
+An utility command line to help you perform requests against a SCIM server, while validating input and response payloads. It also uses [scim2-tester](https://scim2-tester.readthedocs.io) to perform a [SCIM server compliance test](https://scim2-cli.readthedocs.io/en/latest/reference.html#scim-url-test).
+
+## What's SCIM anyway?
+
+SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
+Provisioning is the action of managing a set of resources across different services, usually users and groups.
+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
+```
+
+### 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:
+
+```shell
+uv run scim2 --help
+```
+
+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
+```
+
+## Usage
+
+Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
+
+Here is an example of resource creation:
+
+```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",
+    },
+}
+```
+
+Here is an example of resource query:
+
+```shell
+$ 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"],
+    "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",
+   }
+}
+```
+
+scim2-cli belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
+with [scim2-models](https://github.com/python-scim/scim2-models),
+[scim2-client](https://github.com/python-scim/scim2-client) and
+[scim2-tester](https://github.com/python-scim/scim2-tester)

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

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build>=0.8.9,<0.9.0"]
+build-backend = "uv_build"
 
 [project]
 name = "scim2-cli"
-version = "0.2.3"
+version = "0.2.4"
 description = "SCIM application development CLI"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -17,6 +17,7 @@ classifiers = [
     "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",
@@ -27,8 +28,8 @@ classifiers = [
 requires-python = ">= 3.10"
 dependencies = [
     "click>=8.1.7",
-    "scim2-client>=0.4.3",
-    "scim2-tester[httpx]>=0.1.10",
+    "scim2-client>=0.7.1",
+    "scim2-tester[httpx]>=0.2.5",
     "sphinx-click-rst-to-ansi-formatter>=0.1.0",
     "pydanclick>=0.4.0",
     "pygments>=2.18.0",
@@ -43,7 +44,7 @@ funding = "https://github.com/sponsors/python-scim"
 [dependency-groups]
 dev = [
     "mypy>=1.13.0",
-    "pre-commit-uv>=4.1.4",
+    "prek>=0.1.0",
     "pytest>=8.2.1",
     "pytest-coverage>=0.0",
     "pytest-httpserver>=1.0.10",
@@ -64,6 +65,9 @@ bundle = [
 scim = "scim2_cli:cli"
 scim2 = "scim2_cli:cli"
 
+[tool.uv.build-backend]
+module-root = ""
+
 [tool.coverage.run]
 source = [
     "scim2_cli",
@@ -124,6 +128,7 @@ env_list = [
     "py311",
     "py312",
     "py313",
+    "py314",
     "minversions",
     "doc",
     "coverage",
@@ -139,11 +144,11 @@ commands = [
 [tool.tox.env.style]
 runner = "uv-venv-runner"
 commands = [
-    ["pre-commit", "run", "--all-files", "--show-diff-on-failure"],
+    ["prek", "run", "--all-files", "--show-diff-on-failure"],
 ]
 
 [tool.tox.env.minversions]
-runner = "uv-venv-lock-runner"
+runner = "uv-venv-runner"
 uv_resolution = "lowest-direct"
 
 [tool.tox.env.doc]

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

@@ -100,11 +100,13 @@ def is_field_acceptable(context, model, field_name) -> bool:
 
 
 def unacceptable_fields(context, model):
-    return [
+    excluded = [
         field_name
         for field_name in model.model_fields
         if not is_field_acceptable(context, model, field_name)
     ]
+    excluded.append("schemas")
+    return excluded
 
 
 def exception_to_click_error(exception):

scim2_cli-0.2.3/.github/FUNDING.yml

@@ -1,2 +0,0 @@
----
-github: [yaal-coop]

scim2_cli-0.2.3/.github/workflows/release.yml

@@ -1,61 +0,0 @@
----
-name: bundle
-on:
-  push:
-    tags:
-      - '*'
-
-jobs:
-  build:
-    name: build dist files
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install uv
-        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
-          path: dist/*
-          if-no-files-found: error
-
-  release:
-    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
-    runs-on: ubuntu-latest
-
-    environment:
-      name: pypi-release
-      url: https://pypi.org/project/scim2-cli/
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/download-artifact@v4
-        with:
-          name: artifacts
-          path: dist
-
-      - name: Push build artifacts to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1

scim2_cli-0.2.3/.github/workflows/tests.yaml

@@ -1,77 +0,0 @@
----
-name: tests
-on:
-  push:
-    branches:
-      - main
-      - '*.*.*'
-  pull_request:
-    branches:
-      - main
-      - '*.*.*'
-
-jobs:
-  tests:
-    name: py${{ matrix.python }} unit tests
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python:
-          - '3.13'
-          - '3.12'
-          - '3.11'
-          - '3.10'
-          - '3.9'
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          enable-cache: true
-      - name: Install Python ${{ matrix.python }}
-        run: uv python install ${{ matrix.python }}
-      - name: Run tests
-        run: uv run pytest --showlocals
-
-  minversions:
-    name: minimum dependency versions
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          enable-cache: true
-      - name: Install minimum dependencies
-        run: uv sync --resolution=lowest-direct
-      - name: Run tests
-        run: uv run pytest --showlocals
-
-  style:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - uses: pre-commit/action@v3.0.1
-
-  doc:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          enable-cache: true
-      - 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/.gitignore

@@ -1,16 +0,0 @@
-.env
-*.pyc
-*.mo
-*.prof
-.python_history
-.tox
-.coverage
-.coverage.*
-htmlcov
-*.egg-info
-build
-dist
-.vscode
-
-# pyinstaller spec file
-*.spec

scim2_cli-0.2.3/.hgignore

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

scim2_cli-0.2.3/.pre-commit-config.yaml

@@ -1,29 +0,0 @@
----
-repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.8.2'
-    hooks:
-      - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
-      - id: ruff-format
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: fix-byte-order-marker
-      - id: trailing-whitespace
-        exclude: "\\.svg$|\\.map$|\\.min\\.css$|\\.min\\.js$|\\.po$|\\.pot$"
-      - id: end-of-file-fixer
-        exclude: "\\.svg$|\\.map$|\\.min\\.css$|\\.min\\.js$|\\.po$|\\.pot$"
-      - id: check-toml
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
-    hooks:
-      - id: mypy
-        additional_dependencies: [pydantic]
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
-    hooks:
-    - id: codespell
-      additional_dependencies:
-        - tomli
-      args: [--write-changes]

scim2_cli-0.2.3/.readthedocs.yml

@@ -1,15 +0,0 @@
----
-version: 2
-sphinx:
-  configuration: doc/conf.py
-build:
-  os: "ubuntu-22.04"
-  tools:
-    python: "3.12"
-  jobs:
-    post_create_environment:
-      - pip install uv
-      - uv export --group doc --no-hashes --output-file requirements.txt
-    post_install:
-      - pip install .
-      - pip install --requirement requirements.txt