scim2-client 0.2.1__tar.gz → 0.3.0__tar.gz

{scim2_client-0.2.1 → scim2_client-0.3.0}/.github/workflows/release.yml

@@ -37,7 +37,7 @@ jobs:
 
     environment:
       name: pypi-release
-      url: https://pypi.org/project/scim2-models/
+      url: https://pypi.org/project/scim2-client/
     permissions:
       id-token: write
 

{scim2_client-0.2.1 → scim2_client-0.3.0}/.github/workflows/tests.yaml

@@ -31,6 +31,8 @@ jobs:
           enable-cache: true
       - name: Install Python ${{ matrix.python }}
         run: uv python install ${{ matrix.python }}
+      - name: Install dependencies
+        run: uv sync --all-extras
       - name: Run tests
         run: uv run pytest --showlocals
 
@@ -44,7 +46,7 @@ jobs:
         with:
           enable-cache: true
       - name: Install minimum dependencies
-        run: uv sync --resolution=lowest-direct
+        run: uv sync --resolution=lowest-direct --all-extras
       - name: Run tests
         run: uv run pytest --showlocals
 

{scim2_client-0.2.1 → scim2_client-0.3.0}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.6.9'
+    rev: 'v0.8.0'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
@@ -15,6 +15,11 @@ repos:
       - 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:

{scim2_client-0.2.1 → scim2_client-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-client
-Version: 0.2.1
+Version: 0.3.0
 Summary: Pythonically build SCIM requests and parse SCIM responses
 Project-URL: documentation, https://scim2-client.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-client
@@ -208,7 +208,6 @@ 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: api,httpx,provisioning,rfc7643,rfc7644,scim,scim2
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Web Environment
@@ -223,15 +222,19 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
-Requires-Dist: httpx>=0.24.0
 Requires-Dist: scim2-models>=0.2.0
+Provides-Extra: httpx
+Requires-Dist: httpx>=0.28.0; extra == 'httpx'
+Provides-Extra: werkzeug
+Requires-Dist: werkzeug>=3.1.3; extra == 'werkzeug'
 Description-Content-Type: text/markdown
 
 # scim2-client
 
-A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) and [httpx](https://github.com/encode/httpx),
+A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) ,
 that pythonically build requests and parse responses,
 following the [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html) specifications.
+You can use whatever request engine you prefer to perform network requests, but scim2-models comes with [httpx](https://github.com/encode/httpx) support.
 
 It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
 
@@ -245,7 +248,7 @@ It allows users and groups creations, modifications and deletions to be synchron
 ## Installation
 
 ```shell
-pip install scim2-client
+pip install scim2-client[httpx]
 ```
 
 ## Usage
@@ -258,10 +261,10 @@ Here is an example of usage:
 import datetime
 from httpx import Client
 from scim2_models import User, EnterpriseUser, Group, Error
-from scim2_client import SCIMClient
+from scim2_client.engines.httpx import SyncSCIMClient
 
-client = Client(base_url=f"https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
-scim = SCIMClient(client, resource_types=(User[EnterpriseUser], Group))
+client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
+scim = SyncSCIMClient(client, resource_types=(User[EnterpriseUser], Group))
 
 # Query resources
 user = scim.query(User[EnterpriseUser], "2819c223-7f76-453a-919d-413861904646")

{scim2_client-0.2.1 → scim2_client-0.3.0}/README.md

@@ -1,8 +1,9 @@
 # scim2-client
 
-A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) and [httpx](https://github.com/encode/httpx),
+A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) ,
 that pythonically build requests and parse responses,
 following the [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html) specifications.
+You can use whatever request engine you prefer to perform network requests, but scim2-models comes with [httpx](https://github.com/encode/httpx) support.
 
 It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
 
@@ -16,7 +17,7 @@ It allows users and groups creations, modifications and deletions to be synchron
 ## Installation
 
 ```shell
-pip install scim2-client
+pip install scim2-client[httpx]
 ```
 
 ## Usage
@@ -29,10 +30,10 @@ Here is an example of usage:
 import datetime
 from httpx import Client
 from scim2_models import User, EnterpriseUser, Group, Error
-from scim2_client import SCIMClient
+from scim2_client.engines.httpx import SyncSCIMClient
 
-client = Client(base_url=f"https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
-scim = SCIMClient(client, resource_types=(User[EnterpriseUser], Group))
+client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
+scim = SyncSCIMClient(client, resource_types=(User[EnterpriseUser], Group))
 
 # Query resources
 user = scim.query(User[EnterpriseUser], "2819c223-7f76-453a-919d-413861904646")

{scim2_client-0.2.1 → scim2_client-0.3.0}/doc/changelog.rst

@@ -1,8 +1,36 @@
 Changelog
 =========
 
+[0.3.0] - 2024-11-29
+--------------------
+
+.. warning::
+
+    This version comes with breaking changes:
+
+    - `httpx` is no longer a direct dependency, it is shipped in the `httpx` packaging extra.
+    - ``scim2_client.SCIMClient`` has moved to ``scim2_client.engines.httpx.SyncSCIMClient``.
+    - The ``resource_types`` parameters has been renamed ``resource_models``.
+
+Added
+^^^^^
+- The `Unknown resource type` request error keeps a reference to the faulty payload.
+- New `werkzeug` request engine for application development purpose.
+- New `AsyncSCIMClient` request engine. :issue:`1`
+
+Changed
+^^^^^^^
+- Separate httpx network code and SCIM code in separate file as a basis for async support (and maybe other request engines).
+
+[0.2.2] - 2024-11-12
+--------------------
+
+Added
+^^^^^
+- Mypy type checking and py.typed file :pr:`25`
+
 [0.2.1] - 2024-11-07
----------------------
+--------------------
 
 Added
 ^^^^^
@@ -14,7 +42,7 @@ Fixed
 - Don't crash when servers don't return content type headers. :pr:`22,24`
 
 [0.2.0] - 2024-09-01
----------------------
+--------------------
 
 Added
 ^^^^^

{scim2_client-0.2.1 → scim2_client-0.3.0}/doc/conf.py

@@ -35,7 +35,6 @@ source_suffix = {
 
 version = metadata.version("scim2_client")
 language = "en"
-exclude_patterns = []
 pygments_style = "sphinx"
 todo_include_todos = True
 toctree_collapse = False
@@ -43,6 +42,7 @@ toctree_collapse = False
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "scim2_models": ("https://scim2-models.readthedocs.io/en/latest/", None),
+    "werkzeug": ("https://werkzeug.palletsprojects.com", None),
 }
 
 # -- Options for HTML output ----------------------------------------------

scim2_client-0.3.0/doc/reference.rst

@@ -0,0 +1,14 @@
+Reference
+=========
+
+.. automodule:: scim2_client.engines.httpx
+   :members:
+   :member-order: bysource
+
+.. automodule:: scim2_client.engines.werkzeug
+   :members:
+   :member-order: bysource
+
+.. automodule:: scim2_client
+   :members:
+   :member-order: bysource

{scim2_client-0.2.1 → scim2_client-0.3.0}/doc/tutorial.rst

@@ -4,18 +4,20 @@ Tutorial
 Initialization
 ==============
 
-scim2-client depends on `httpx <https://github.com/encode/httpx>`_ to perform network requests.
-As a start you will need to instantiate a httpx :code:`Client` object that you can parameter as your will, and then pass it to a :class:`~scim2_client.SCIMClient` object.
+scim2-client depends on request engines such as `httpx <https://github.com/encode/httpx>`_ to perform network requests.
+This tutorial demonstrate how to use scim2-client with httpx, and suppose you have installed the `httpx` extra for example with ``pip install scim2-models[httpx]``.
+
+As a start you will need to instantiate a httpx :code:`Client` object that you can parameter as your will, and then pass it to a :class:`SCIM client <scim2_client.BaseSCIMClient>` object.
 In addition to your SCIM server root endpoint, you will probably want to provide some authorization headers through the httpx :code:`Client` :code:`headers` parameter:
 
 .. code-block:: python
 
     from httpx import Client
     from scim2_models import User, EnterpriseUserUser, Group
-    from scim2_client import SCIMClient
+    from scim2_client.engines.httpx import SyncSCIMClient
 
     client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
-    scim = SCIMClient(client, resource_types=(User[EnterpriseUser], Group))
+    scim = SyncSCIMClient(client, resource_types=(User[EnterpriseUser], Group))
 
 You need to give to indicate to :class:`~scim2_client.SCIMClient` all the different :class:`~scim2_models.Resource` types that you will need to manipulate with the :code:`resource_types` parameter.
 This is needed so scim2-client will be able to guess which resource type to instante when an arbitrary payload is met.
@@ -31,11 +33,11 @@ Performing actions
 scim2-client allows your application to interact with a SCIM server as described in :rfc:`RFC7644 §3 <7644#section-3>`, so you can read and manage the resources.
 The following actions are available:
 
-- :meth:`~scim2_client.SCIMClient.create`
-- :meth:`~scim2_client.SCIMClient.query`
-- :meth:`~scim2_client.SCIMClient.replace`
-- :meth:`~scim2_client.SCIMClient.delete`
-- :meth:`~scim2_client.SCIMClient.search`
+- :meth:`~scim2_client.BaseSCIMClient.create`
+- :meth:`~scim2_client.BaseSCIMClient.query`
+- :meth:`~scim2_client.BaseSCIMClient.replace`
+- :meth:`~scim2_client.BaseSCIMClient.delete`
+- :meth:`~scim2_client.BaseSCIMClient.search`
 
 Have a look at the :doc:`reference` to see usage examples and the exhaustive set of parameters, but generally it looks like this:
 
@@ -58,7 +60,7 @@ Have a look at the :doc:`reference` to see usage examples and the exhaustive set
 Request and response validation
 ===============================
 
-By default, the data passed to the :class:`~scim2_client.SCIMClient` as well as the server response will be validated against the SCIM specifications, and will raise an error if they don't respect them.
+By default, the data passed to the :class:`SCIM client <scim2_client.BaseSCIMClient>` as well as the server response will be validated against the SCIM specifications, and will raise an error if they don't respect them.
 However sometimes you want to accept invalid inputs and outputs.
 To achieve this, all the methods provide the following parameters, all are :data:`True` by default:
 
@@ -81,10 +83,24 @@ To achieve this, all the methods provide the following parameters, all are :data
    which value will excluded from the request payload, and which values are
    expected in the response payload.
 
+Engines
+=======
+
+scim2-client comes with a light abstraction layers that allows for different requests engines.
+Currently those engines are shipped:
+
+- :class:`~scim2_client.engines.httpx.SyncSCIMClient`: A synchronous engine using `httpx <https://github.com/encode/httpx>`_ to perform the HTTP requests.
+- :class:`~scim2_client.engines.httpx.AsyncSCIMClient`: An asynchronous engine using `httpx <https://github.com/encode/httpx>`_ to perform the HTTP requests. It has the very same API than its synchronous version, except it is asynchronous.
+- :class:`~scim2_client.engines.werkzeug.TestSCIMClient`: A test engine for development purposes.
+  It takes a WSGI app and directly execute the server code instead of performing real HTTP requests.
+  This is faster in unit test suites, and helpful to catch the server exceptions.
+
+You can easily implement your own engine by inheriting from :class:`~scim2_client.BaseSCIMClient`.
+
 Additional request parameters
 =============================
 
-Any additional parameter will be passed to the underlying httpx methods.
+Any additional parameter will be passed to the underlying engine methods.
 This can be useful if you need to explicitly pass a certain URL for example:
 
 .. code-block:: python

{scim2_client-0.2.1 → scim2_client-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-client"
-version = "0.2.1"
+version = "0.3.0"
 description = "Pythonically build SCIM requests and parse SCIM responses"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}
@@ -27,10 +27,18 @@ classifiers = [
 
 requires-python = ">= 3.9"
 dependencies = [
-    "httpx>=0.24.0",
     "scim2-models>=0.2.0",
 ]
 
+[project.optional-dependencies]
+httpx = [
+    "httpx>=0.28.0",
+]
+
+werkzeug = [
+    "werkzeug>=3.1.3",
+]
+
 [project.urls]
 documentation = "https://scim2-client.readthedocs.io"
 repository = "https://github.com/python-scim/scim2-client"
@@ -39,13 +47,17 @@ funding = "https://github.com/sponsors/python-scim"
 
 [dependency-groups]
 dev = [
+    "mypy>=1.13.0",
+    "portpicker>=1.6.0",
     "pre-commit-uv>=4.1.4",
     "pytest>=8.2.1",
+    "pytest-asyncio>=0.24.0",
     "pytest-coverage>=0.0",
-    "pytest-httpserver>=1.0.10",
+    "pytest-httpserver>=1.1.0",
+    "scim2-server >= 0.1.2; python_version>='3.10'",
     "tox-uv>=1.16.0",
+    "werkzeug>=3.1.3",
 ]
-
 doc = [
     "autodoc-pydantic>=2.2.0",
     "myst-parser>=3.0.1",
@@ -100,6 +112,15 @@ force-single-line = true
 [tool.ruff.format]
 docstring-code-format = true
 
+[tool.mypy]
+plugins = [
+  "pydantic.mypy"
+]
+
+[tool.pytest.ini_options]
+asyncio_mode="auto"
+asyncio_default_fixture_loop_scope = "function"
+
 [tool.tox]
 requires = ["tox>=4.19"]
 env_list = [
@@ -115,6 +136,7 @@ env_list = [
 ]
 
 [tool.tox.env_run_base]
+extras = ["httpx", "werkzeug"]
 runner = "uv-venv-lock-runner"
 dependency_groups = ["dev"]
 commands = [

{scim2_client-0.2.1 → scim2_client-0.3.0}/scim2_client/__init__.py

@@ -1,4 +1,5 @@
-from .client import SCIMClient
+from .client import BaseSCIMClient
+from .client import BaseSyncSCIMClient
 from .errors import RequestNetworkError
 from .errors import RequestPayloadValidationError
 from .errors import ResponsePayloadValidationError
@@ -11,7 +12,8 @@ from .errors import UnexpectedContentType
 from .errors import UnexpectedStatusCode
 
 __all__ = [
-    "SCIMClient",
+    "BaseSCIMClient",
+    "BaseSyncSCIMClient",
     "SCIMClientError",
     "SCIMRequestError",
     "SCIMResponseError",