scim2-client 0.6.1__tar.gz → 0.7.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. scim2_client-0.7.0/PKG-INFO +298 -0
  2. {scim2_client-0.6.1 → scim2_client-0.7.0}/pyproject.toml +13 -10
  3. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/client.py +130 -146
  4. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/engines/httpx.py +84 -98
  5. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/engines/werkzeug.py +44 -52
  6. scim2_client-0.6.1/.github/FUNDING.yml +0 -2
  7. scim2_client-0.6.1/.github/workflows/release.yml +0 -51
  8. scim2_client-0.6.1/.github/workflows/tests.yaml +0 -69
  9. scim2_client-0.6.1/.gitignore +0 -13
  10. scim2_client-0.6.1/.pre-commit-config.yaml +0 -29
  11. scim2_client-0.6.1/.readthedocs.yml +0 -15
  12. scim2_client-0.6.1/PKG-INFO +0 -298
  13. scim2_client-0.6.1/doc/changelog.rst +0 -261
  14. scim2_client-0.6.1/doc/conf.py +0 -78
  15. scim2_client-0.6.1/doc/contributing.rst +0 -47
  16. scim2_client-0.6.1/doc/index.rst +0 -14
  17. scim2_client-0.6.1/doc/reference.rst +0 -14
  18. scim2_client-0.6.1/doc/tutorial.rst +0 -217
  19. scim2_client-0.6.1/scim2_client/engines/__init__.py +0 -0
  20. scim2_client-0.6.1/tests/__init__.py +0 -0
  21. scim2_client-0.6.1/tests/conftest.py +0 -17
  22. scim2_client-0.6.1/tests/engines/__init__.py +0 -0
  23. scim2_client-0.6.1/tests/engines/test_httpx.py +0 -156
  24. scim2_client-0.6.1/tests/engines/test_werkzeug.py +0 -108
  25. scim2_client-0.6.1/tests/test_create.py +0 -287
  26. scim2_client-0.6.1/tests/test_delete.py +0 -83
  27. scim2_client-0.6.1/tests/test_discovery.py +0 -96
  28. scim2_client-0.6.1/tests/test_modify.py +0 -408
  29. scim2_client-0.6.1/tests/test_query.py +0 -576
  30. scim2_client-0.6.1/tests/test_replace.py +0 -312
  31. scim2_client-0.6.1/tests/test_search.py +0 -253
  32. scim2_client-0.6.1/tests/test_utils.py +0 -49
  33. scim2_client-0.6.1/uv.lock +0 -1595
  34. {scim2_client-0.6.1 → scim2_client-0.7.0}/LICENSE.md +0 -0
  35. {scim2_client-0.6.1 → scim2_client-0.7.0}/README.md +0 -0
  36. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/__init__.py +0 -0
  37. {scim2_client-0.6.1/doc → scim2_client-0.7.0/scim2_client/engines}/__init__.py +0 -0
  38. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/errors.py +0 -0
  39. {scim2_client-0.6.1 → scim2_client-0.7.0}/scim2_client/py.typed +0 -0
@@ -0,0 +1,298 @@
1
+ Metadata-Version: 2.3
2
+ Name: scim2-client
3
+ Version: 0.7.0
4
+ Summary: Pythonically build SCIM requests and parse SCIM responses
5
+ Keywords: scim,scim2,provisioning,rfc7643,rfc7644,httpx,api
6
+ Author: Yaal Coop
7
+ Author-email: Yaal Coop <contact@yaal.coop>
8
+ License: Apache License
9
+ Version 2.0, January 2004
10
+ http://www.apache.org/licenses/
11
+
12
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+ 1. Definitions.
15
+
16
+ "License" shall mean the terms and conditions for use, reproduction,
17
+ and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+ "Licensor" shall mean the copyright owner or entity authorized by
20
+ the copyright owner that is granting the License.
21
+
22
+ "Legal Entity" shall mean the union of the acting entity and all
23
+ other entities that control, are controlled by, or are under common
24
+ control with that entity. For the purposes of this definition,
25
+ "control" means (i) the power, direct or indirect, to cause the
26
+ direction or management of such entity, whether by contract or
27
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+ "You" (or "Your") shall mean an individual or Legal Entity
31
+ exercising permissions granted by this License.
32
+
33
+ "Source" form shall mean the preferred form for making modifications,
34
+ including but not limited to software source code, documentation
35
+ source, and configuration files.
36
+
37
+ "Object" form shall mean any form resulting from mechanical
38
+ transformation or translation of a Source form, including but
39
+ not limited to compiled object code, generated documentation,
40
+ and conversions to other media types.
41
+
42
+ "Work" shall mean the work of authorship, whether in Source or
43
+ Object form, made available under the License, as indicated by a
44
+ copyright notice that is included in or attached to the work
45
+ (an example is provided in the Appendix below).
46
+
47
+ "Derivative Works" shall mean any work, whether in Source or Object
48
+ form, that is based on (or derived from) the Work and for which the
49
+ editorial revisions, annotations, elaborations, or other modifications
50
+ represent, as a whole, an original work of authorship. For the purposes
51
+ of this License, Derivative Works shall not include works that remain
52
+ separable from, or merely link (or bind by name) to the interfaces of,
53
+ the Work and Derivative Works thereof.
54
+
55
+ "Contribution" shall mean any work of authorship, including
56
+ the original version of the Work and any modifications or additions
57
+ to that Work or Derivative Works thereof, that is intentionally
58
+ submitted to Licensor for inclusion in the Work by the copyright owner
59
+ or by an individual or Legal Entity authorized to submit on behalf of
60
+ the copyright owner. For the purposes of this definition, "submitted"
61
+ means any form of electronic, verbal, or written communication sent
62
+ to the Licensor or its representatives, including but not limited to
63
+ communication on electronic mailing lists, source code control systems,
64
+ and issue tracking systems that are managed by, or on behalf of, the
65
+ Licensor for the purpose of discussing and improving the Work, but
66
+ excluding communication that is conspicuously marked or otherwise
67
+ designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+ "Contributor" shall mean Licensor and any individual or Legal Entity
70
+ on behalf of whom a Contribution has been received by Licensor and
71
+ subsequently incorporated within the Work.
72
+
73
+ 2. Grant of Copyright License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ copyright license to reproduce, prepare Derivative Works of,
77
+ publicly display, publicly perform, sublicense, and distribute the
78
+ Work and such Derivative Works in Source or Object form.
79
+
80
+ 3. Grant of Patent License. Subject to the terms and conditions of
81
+ this License, each Contributor hereby grants to You a perpetual,
82
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+ (except as stated in this section) patent license to make, have made,
84
+ use, offer to sell, sell, import, and otherwise transfer the Work,
85
+ where such license applies only to those patent claims licensable
86
+ by such Contributor that are necessarily infringed by their
87
+ Contribution(s) alone or by combination of their Contribution(s)
88
+ with the Work to which such Contribution(s) was submitted. If You
89
+ institute patent litigation against any entity (including a
90
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+ or a Contribution incorporated within the Work constitutes direct
92
+ or contributory patent infringement, then any patent licenses
93
+ granted to You under this License for that Work shall terminate
94
+ as of the date such litigation is filed.
95
+
96
+ 4. Redistribution. You may reproduce and distribute copies of the
97
+ Work or Derivative Works thereof in any medium, with or without
98
+ modifications, and in Source or Object form, provided that You
99
+ meet the following conditions:
100
+
101
+ (a) You must give any other recipients of the Work or
102
+ Derivative Works a copy of this License; and
103
+
104
+ (b) You must cause any modified files to carry prominent notices
105
+ stating that You changed the files; and
106
+
107
+ (c) You must retain, in the Source form of any Derivative Works
108
+ that You distribute, all copyright, patent, trademark, and
109
+ attribution notices from the Source form of the Work,
110
+ excluding those notices that do not pertain to any part of
111
+ the Derivative Works; and
112
+
113
+ (d) If the Work includes a "NOTICE" text file as part of its
114
+ distribution, then any Derivative Works that You distribute must
115
+ include a readable copy of the attribution notices contained
116
+ within such NOTICE file, excluding those notices that do not
117
+ pertain to any part of the Derivative Works, in at least one
118
+ of the following places: within a NOTICE text file distributed
119
+ as part of the Derivative Works; within the Source form or
120
+ documentation, if provided along with the Derivative Works; or,
121
+ within a display generated by the Derivative Works, if and
122
+ wherever such third-party notices normally appear. The contents
123
+ of the NOTICE file are for informational purposes only and
124
+ do not modify the License. You may add Your own attribution
125
+ notices within Derivative Works that You distribute, alongside
126
+ or as an addendum to the NOTICE text from the Work, provided
127
+ that such additional attribution notices cannot be construed
128
+ as modifying the License.
129
+
130
+ You may add Your own copyright statement to Your modifications and
131
+ may provide additional or different license terms and conditions
132
+ for use, reproduction, or distribution of Your modifications, or
133
+ for any such Derivative Works as a whole, provided Your use,
134
+ reproduction, and distribution of the Work otherwise complies with
135
+ the conditions stated in this License.
136
+
137
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
138
+ any Contribution intentionally submitted for inclusion in the Work
139
+ by You to the Licensor shall be under the terms and conditions of
140
+ this License, without any additional terms or conditions.
141
+ Notwithstanding the above, nothing herein shall supersede or modify
142
+ the terms of any separate license agreement you may have executed
143
+ with Licensor regarding such Contributions.
144
+
145
+ 6. Trademarks. This License does not grant permission to use the trade
146
+ names, trademarks, service marks, or product names of the Licensor,
147
+ except as required for reasonable and customary use in describing the
148
+ origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+ 7. Disclaimer of Warranty. Unless required by applicable law or
151
+ agreed to in writing, Licensor provides the Work (and each
152
+ Contributor provides its Contributions) on an "AS IS" BASIS,
153
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+ implied, including, without limitation, any warranties or conditions
155
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+ PARTICULAR PURPOSE. You are solely responsible for determining the
157
+ appropriateness of using or redistributing the Work and assume any
158
+ risks associated with Your exercise of permissions under this License.
159
+
160
+ 8. Limitation of Liability. In no event and under no legal theory,
161
+ whether in tort (including negligence), contract, or otherwise,
162
+ unless required by applicable law (such as deliberate and grossly
163
+ negligent acts) or agreed to in writing, shall any Contributor be
164
+ liable to You for damages, including any direct, indirect, special,
165
+ incidental, or consequential damages of any character arising as a
166
+ result of this License or out of the use or inability to use the
167
+ Work (including but not limited to damages for loss of goodwill,
168
+ work stoppage, computer failure or malfunction, or any and all
169
+ other commercial damages or losses), even if such Contributor
170
+ has been advised of the possibility of such damages.
171
+
172
+ 9. Accepting Warranty or Additional Liability. While redistributing
173
+ the Work or Derivative Works thereof, You may choose to offer,
174
+ and charge a fee for, acceptance of support, warranty, indemnity,
175
+ or other liability obligations and/or rights consistent with this
176
+ License. However, in accepting such obligations, You may act only
177
+ on Your own behalf and on Your sole responsibility, not on behalf
178
+ of any other Contributor, and only if You agree to indemnify,
179
+ defend, and hold each Contributor harmless for any liability
180
+ incurred by, or claims asserted against, such Contributor by reason
181
+ of your accepting any such warranty or additional liability.
182
+
183
+ END OF TERMS AND CONDITIONS
184
+
185
+ APPENDIX: How to apply the Apache License to your work.
186
+
187
+ To apply the Apache License to your work, attach the following
188
+ boilerplate notice, with the fields enclosed by brackets "[]"
189
+ replaced with your own identifying information. (Don't include
190
+ the brackets!) The text should be enclosed in the appropriate
191
+ comment syntax for the file format. We also recommend that a
192
+ file or class name and description of purpose be included on the
193
+ same "printed page" as the copyright notice for easier
194
+ identification within third-party archives.
195
+
196
+ Copyright [yyyy] [name of copyright owner]
197
+
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+ Classifier: Intended Audience :: Developers
210
+ Classifier: Development Status :: 3 - Alpha
211
+ Classifier: Programming Language :: Python :: 3.10
212
+ Classifier: Programming Language :: Python :: 3.11
213
+ Classifier: Programming Language :: Python :: 3.12
214
+ Classifier: Programming Language :: Python :: 3.13
215
+ Classifier: Programming Language :: Python :: 3.14
216
+ Classifier: Programming Language :: Python :: Implementation :: CPython
217
+ Classifier: License :: OSI Approved :: Apache Software License
218
+ Classifier: Environment :: Web Environment
219
+ Classifier: Programming Language :: Python
220
+ Classifier: Operating System :: OS Independent
221
+ Requires-Dist: scim2-models>=0.6.1
222
+ Requires-Dist: httpx>=0.28.0 ; extra == 'httpx'
223
+ Requires-Dist: werkzeug>=3.1.3 ; extra == 'werkzeug'
224
+ Requires-Python: >=3.10
225
+ Project-URL: changelog, https://scim2-client.readthedocs.io/en/latest/changelog.html
226
+ Project-URL: documentation, https://scim2-client.readthedocs.io
227
+ Project-URL: funding, https://github.com/sponsors/python-scim
228
+ Project-URL: repository, https://github.com/python-scim/scim2-client
229
+ Provides-Extra: httpx
230
+ Provides-Extra: werkzeug
231
+ Description-Content-Type: text/markdown
232
+
233
+ # scim2-client
234
+
235
+ A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) ,
236
+ that pythonically build requests and parse responses,
237
+ following the [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html) specifications.
238
+ You can use whatever request engine you prefer to perform network requests, but scim2-client comes with [httpx](https://github.com/encode/httpx) support.
239
+
240
+ It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
241
+
242
+ ## What's SCIM anyway?
243
+
244
+ SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
245
+ Provisioning is the action of managing a set of resources across different services, usually users and groups.
246
+ SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
247
+ It allows users and groups creations, modifications and deletions to be synchronized between applications.
248
+
249
+ ## Installation
250
+
251
+ ```shell
252
+ pip install scim2-client[httpx]
253
+ ```
254
+
255
+ ## Usage
256
+
257
+ Check the [tutorial](https://scim2-client.readthedocs.io/en/latest/tutorial.html)
258
+ and the [reference](https://scim2-client.readthedocs.io/en/latest/reference.html) for more details.
259
+
260
+ Here is an example of usage:
261
+
262
+ ```python
263
+ import datetime
264
+ from httpx import Client
265
+ from scim2_models import Error
266
+ from scim2_client.engines.httpx import SyncSCIMClient
267
+
268
+ client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
269
+ scim = SyncSCIMClient(client)
270
+ scim.discover()
271
+ User = scim.get_resource_model("User")
272
+
273
+ # Query resources
274
+ user = scim.query(User, "2819c223-7f76-453a-919d-413861904646")
275
+ assert user.user_name == "bjensen@example.com"
276
+ assert user.meta.last_updated == datetime.datetime(
277
+ 2024, 4, 13, 12, 0, 0, tzinfo=datetime.timezone.utc
278
+ )
279
+
280
+ # Update resources
281
+ user.display_name = "Babs Jensen"
282
+ user = scim.replace(user)
283
+ assert user.display_name == "Babs Jensen"
284
+ assert user.meta.last_updated == datetime.datetime(
285
+ 2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
286
+ )
287
+
288
+ # Create resources
289
+ payload = User(user_name="bjensen@example.com")
290
+ response = scim.create(user)
291
+ assert isinstance(response, Error)
292
+ assert response.detail == "One or more of the attribute values are already in use or are reserved."
293
+ ```
294
+
295
+ scim2-client belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
296
+ with [scim2-models](https://github.com/python-scim/scim2-models),
297
+ [scim2-tester](https://github.com/python-scim/scim2-tester) and
298
+ [scim2-cli](https://github.com/python-scim/scim2-cli)
@@ -1,10 +1,10 @@
1
1
  [build-system]
2
- requires = ["hatchling"]
3
- build-backend = "hatchling.build"
2
+ requires = ["uv_build>=0.8.9,<0.9.0"]
3
+ build-backend = "uv_build"
4
4
 
5
5
  [project]
6
6
  name = "scim2-client"
7
- version = "0.6.1"
7
+ version = "0.7.0"
8
8
  description = "Pythonically build SCIM requests and parse SCIM responses"
9
9
  authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
10
10
  license = {file = "LICENSE.md"}
@@ -13,11 +13,11 @@ keywords = ["scim", "scim2", "provisioning", "rfc7643", "rfc7644", "httpx", "api
13
13
  classifiers = [
14
14
  "Intended Audience :: Developers",
15
15
  "Development Status :: 3 - Alpha",
16
- "Programming Language :: Python :: 3.9",
17
16
  "Programming Language :: Python :: 3.10",
18
17
  "Programming Language :: Python :: 3.11",
19
18
  "Programming Language :: Python :: 3.12",
20
19
  "Programming Language :: Python :: 3.13",
20
+ "Programming Language :: Python :: 3.14",
21
21
  "Programming Language :: Python :: Implementation :: CPython",
22
22
  "License :: OSI Approved :: Apache Software License",
23
23
  "Environment :: Web Environment",
@@ -25,9 +25,9 @@ classifiers = [
25
25
  "Operating System :: OS Independent",
26
26
  ]
27
27
 
28
- requires-python = ">= 3.9"
28
+ requires-python = ">= 3.10"
29
29
  dependencies = [
30
- "scim2-models>=0.4.1",
30
+ "scim2-models>=0.6.1",
31
31
  ]
32
32
 
33
33
  [project.optional-dependencies]
@@ -45,16 +45,19 @@ repository = "https://github.com/python-scim/scim2-client"
45
45
  changelog = "https://scim2-client.readthedocs.io/en/latest/changelog.html"
46
46
  funding = "https://github.com/sponsors/python-scim"
47
47
 
48
+ [tool.uv.build-backend]
49
+ module-root = ""
50
+
48
51
  [dependency-groups]
49
52
  dev = [
50
53
  "mypy>=1.13.0",
51
54
  "portpicker>=1.6.0",
52
- "pre-commit-uv>=4.1.4",
55
+ "prek>=0.1.0",
53
56
  "pytest>=8.2.1",
54
57
  "pytest-asyncio>=0.24.0",
55
58
  "pytest-coverage>=0.0",
56
59
  "pytest-httpserver>=1.1.0",
57
- "scim2-server >= 0.1.6; python_version>='3.10'",
60
+ "scim2-server >= 0.1.8",
58
61
  "tox-uv>=1.16.0",
59
62
  "werkzeug>=3.1.3",
60
63
  ]
@@ -129,11 +132,11 @@ asyncio_default_fixture_loop_scope = "function"
129
132
  requires = ["tox>=4.19"]
130
133
  env_list = [
131
134
  "style",
132
- "py39",
133
135
  "py310",
134
136
  "py311",
135
137
  "py312",
136
138
  "py313",
139
+ "py314",
137
140
  "minversions",
138
141
  "doc",
139
142
  "coverage",
@@ -150,7 +153,7 @@ commands = [
150
153
  [tool.tox.env.style]
151
154
  runner = "uv-venv-runner"
152
155
  commands = [
153
- ["pre-commit", "run", "--all-files", "--show-diff-on-failure"],
156
+ ["prek", "run", "--all-files", "--show-diff-on-failure"],
154
157
  ]
155
158
 
156
159
  [tool.tox.env.minversions]