zosmfrestapi 0.2.0__tar.gz → 0.3.0__tar.gz

zosmfrestapi-0.3.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: zosmfrestapi
+Version: 0.3.0
+Summary: A Python wrapper for the z/OSMF REST API
+License-Expression: MIT
+License-File: LICENSE
+Keywords: z/OSMF,IBM Z,mainframe,REST API
+Author: Oscar Curero
+Author-email: dev@curero.es
+Requires-Python: >=3.12
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: zcrypto
+Requires-Dist: dacite (>=1.9.2,<2.0.0)
+Requires-Dist: httpx2 (>=2.12.0,<3.0.0)
+Requires-Dist: pendulum (>=3.2.0,<4.0.0)
+Requires-Dist: py_zcrypto ; extra == "zcrypto"
+Project-URL: Homepage, https://sr.ht/~ocurero/zosmfrestapi/
+Project-URL: Issues, https://todo.sr.ht/~ocurero/zosmfrestapi
+Project-URL: PyPI, https://pypi.org/project/zosmfrestapi/
+Project-URL: Repository, https://git.sr.ht/~ocurero/zosmfrestapi
+Description-Content-Type: text/markdown
+
+# A Python wrapper for the z/OSMF REST API
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+[![100% coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+
+* Website: <https://sr.ht/~ocurero/zosmfrestapi/>
+* Repository: <https://git.sr.ht/~ocurero/zosmfrestapi>
+* Changelog: <https://git.sr.ht/~ocurero/zosmfrestapi/tree/main/item/CHANGELOG.md>
+
+Key features:
+* **Pure Python**: Package and its dependencies are 100% pure Python (no C extensions required).
+* **Cross-platform**: Works on Windows, Linux, macOS, and z/OS UNIX System Services.
+* **Flexible authentication**: Supports user/password, LTPA and JWT tokens, and mutual TLS (mTLS).
+* **Proxy ready**: Full support for standard HTTP/HTTPS proxies as well as authenticated proxies.
+
+![ZosmfClient demo](docs/ZosmfClient.gif)
+
+
+Install
+-------
+
+**zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
+
+Install the package from PyPI:
+
+```console
+python -m pip install zosmfrestapi
+```
+
+If you have downloaded or cloned the source code, run this from the project's
+root folder instead:
+
+```console
+python -m pip install .
+```
+
+## Quickstart
+
+```python
+
+from zosmfrestapi import ZosmfClient
+
+with ZosmfClient("https://zosmf.example",
+                 username="demouser", password="itsasecret") as client:
+    for instance in client.list_swis():
+        print(f"{instance.name} ({instance.system})")
+```
+
+The `with` block closes the network connection automatically, even if a request
+fails. `list_swis()` returns Python objects; the example prints each software
+instance's name and system. You can also query systems or read a data set. Put
+these calls inside the `with` block shown above, before it ends:
+
+```python
+systems = client.get_systems()
+contents = client.read_dataset("USER.DATASET")
+```
+
+These calls must be made inside the `with` block, before the client is closed.
+For a partitioned data set member, use a name such as
+`USER.PDS(MEMBER)`.
+
+## Clients
+
+The library provides two client implementations:
+
+* **`ZosmfClient`**: The standard synchronous client for communicating with z/OSMF using username/password, tokens, or standard TLS certificate files.
+* **`ZosmfZcryptoClient`**: A specialized client for z/OS environments that extracts mutual TLS (mTLS) client certificates directly from SAF key rings (RACF, ACF2, Top Secret).
+
+### Platform Support
+
+| Client | Linux | macOS | Windows | z/OS USS |
+| --- | :---: | :---: | :---: | :---: |
+| `ZosmfClient` | ✅ | ✅ | ✅ | ✅ |
+| `ZosmfZcryptoClient` | ❌ | ❌ | ❌ | ✅ |
+
+### Using `ZosmfZcryptoClient` on z/OS
+
+![ZosmfZcryptoClient demo](docs/ZosmfZcryptoClient.gif)
+
+`ZosmfZcryptoClient` retrieves client certificates and private keys directly from a SAF key ring, exporting temporary PEM files and configuring mutual TLS transparently. When using a key ring owned by the current user, specify the ring name as "name". When using a key ring owned by another user, specify the ring name as "userid/name":
+
+```python
+from zosmfrestapi import ZosmfZcryptoClient
+
+with ZosmfZcryptoClient("https://zosmf.example",
+                        keyring="userid/name", label="zOSMF Client Certificate") as client:
+    systems = client.get_systems()
+```
+
+Install the optional `zcrypto` extra:
+
+```console
+python -m pip install "zosmfrestapi[zcrypto]"
+```
+
+> [!WARNING]
+> The `zcrypto` extra requires `py_zcrypto`, a C extension that compiles against z/OS System SSL C headers. Therefore, it can **only** be installed and executed on **z/OS** systems. Attempting to install or use `ZosmfZcryptoClient` on Linux, macOS, or Windows will raise a `RuntimeError`.
+
+
+
+## Authentication and TLS
+
+The client uses the server's normal TLS certificate checks by default. Keep
+those checks enabled for routine use. The HTTP transport is HTTPX2; HTTPX2 uses `truststore`
+to integrate operating-system certificate stores when it creates its default TLS context.
+zosmfrestapi currently passes its own context, created with Python's
+`ssl.create_default_context()`, so the certificates available to Python are used.
+If the z/OSMF server's CA is no trusted in that environment, pass its certificate file
+with `cafile` below.
+
+| Situation | Client option |
+| --- | --- |
+| User ID and password | `username="...", password="..."` |
+| Client certificate and key in separate files | `cert=("client.crt", "client.key")` |
+| Client certificate and key in one PEM file | `cert="client.pem"` |
+| Internal certificate authority | `cafile="company-ca.pem"` |
+| Existing LTPA or JWT token | `ltpa_token="..."` or `jwt_token="..."` |
+| Identity propagation (needs [PH68412](https://www.ibm.com/support/pages/apar/PH68412))   | None |
+| Network proxy | `proxy="http://proxy.example.com:8080"` |
+
+For example, to trust an internal certificate authority, pass `cafile` when
+creating the client:
+
+```python
+with ZosmfClient("https://zosmf.example", username="demouser", password="itsasecret",
+                 cafile="company-ca.pem") as client:
+    systems = client.get_systems()
+```
+
+The `insecure=True` option disables TLS certificate verification; use it only for temporary
+diagnostics, never as a production fix. It cannot be combined with `cert` or `cafile`.
+
+## Supported APIs
+
+| API Category | Description | Key Methods (examples) |
+| --- | --- | --- |
+| **Authentication** | Basic Auth, LTPA / JWT tokens session login | `authenticate()` |
+| **Topology** | Query systems and sysplex groups defined in z/OSMF | `get_groups()`, `get_systems()` |
+| **Datasets** | Sequential and partitioned dataset retrieval | `read_dataset()` |
+| **Software Management** | SMP/E software instances, CSI queries, and datasets | `list_swis()`, `get_swi_by_name()`, `query_csi_by_name()` |
+| **Software Updates** | Search, inspect, start, monitor, and cancel update processes | `search_sw_updates_by_name()`, `start_sw_update_by_name()`, `check_sw_update_status()` |
+| **Workflows** | List, create, inspect, execute, monitor, and archive workflows | `get_workflows()`, `create_workflow()`, `start_workflow()`, `wait_for_workflow()` |
+
+Some operations change z/OSMF state. Check the method documentation and make
+sure your account has the required permissions before using them.
+
+## Troubleshooting
+
+* **Python version error:** install Python 3.12 or newer, then recreate the
+    virtual environment with that interpreter.
+* **401 / unauthorized:** check the server URL, user ID, password or token, and
+    whether the account is authorized for the requested API.
+* **Certificate verification error:** ask your z/OSMF administrator for the
+    correct CA certificate and pass its path with `cafile`.
+* **Connection or timeout error:** check that the server and port are reachable
+    from your machine and that any required proxy is configured.
+* **PowerShell will not activate the virtual environment:** use the Python
+    executable inside `.venv\Scripts\python.exe` to run commands, or follow your
+    organization's PowerShell policy guidance. Do not change the machine-wide
+    execution policy just to install this package.
+
+For the complete API, parameters, and return types, see the docstrings in the
+package source and the project website.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on development, testing, and submitting patches.
+
+## Issues and Feedback
+
+If you encounter any bugs or have feature requests, please report them on the [SourceHut issue tracker](https://todo.sr.ht/~ocurero/zosmfrestapi).
+
+## License
+
+The MIT License. See [LICENSE](LICENSE).
+
+## Trademarks
+
+IBM, the IBM logo, z/OS, MVS, and Z/OSMF are trademarks or are
+registered trademarks of International Business Machines Corporation,
+registered in many jurisdictions worldwide.  Other product and service
+names might be trademarks of IBM or other companies. A current list
+of IBM trademarks is available at <https://www.ibm.com/legal/copytrade>.
+
+This project is an independent community effort. It is not affiliated
+with, endorsed by, or sponsored by IBM.
+

zosmfrestapi-0.3.0/README.md

@@ -0,0 +1,191 @@
+# A Python wrapper for the z/OSMF REST API
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![builds.sr.ht status](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml.svg)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+[![100% coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://builds.sr.ht/~ocurero/zosmfrestapi/commits/main/.build.yml?)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![z/OS](https://img.shields.io/badge/works%20on-z/OS-8A2BE2)
+
+* Website: <https://sr.ht/~ocurero/zosmfrestapi/>
+* Repository: <https://git.sr.ht/~ocurero/zosmfrestapi>
+* Changelog: <https://git.sr.ht/~ocurero/zosmfrestapi/tree/main/item/CHANGELOG.md>
+
+Key features:
+* **Pure Python**: Package and its dependencies are 100% pure Python (no C extensions required).
+* **Cross-platform**: Works on Windows, Linux, macOS, and z/OS UNIX System Services.
+* **Flexible authentication**: Supports user/password, LTPA and JWT tokens, and mutual TLS (mTLS).
+* **Proxy ready**: Full support for standard HTTP/HTTPS proxies as well as authenticated proxies.
+
+![ZosmfClient demo](docs/ZosmfClient.gif)
+
+
+Install
+-------
+
+**zosmfrestapi** requires Python 3.12 or newer and access to a z/OSMF server.
+
+Install the package from PyPI:
+
+```console
+python -m pip install zosmfrestapi
+```
+
+If you have downloaded or cloned the source code, run this from the project's
+root folder instead:
+
+```console
+python -m pip install .
+```
+
+## Quickstart
+
+```python
+
+from zosmfrestapi import ZosmfClient
+
+with ZosmfClient("https://zosmf.example",
+                 username="demouser", password="itsasecret") as client:
+    for instance in client.list_swis():
+        print(f"{instance.name} ({instance.system})")
+```
+
+The `with` block closes the network connection automatically, even if a request
+fails. `list_swis()` returns Python objects; the example prints each software
+instance's name and system. You can also query systems or read a data set. Put
+these calls inside the `with` block shown above, before it ends:
+
+```python
+systems = client.get_systems()
+contents = client.read_dataset("USER.DATASET")
+```
+
+These calls must be made inside the `with` block, before the client is closed.
+For a partitioned data set member, use a name such as
+`USER.PDS(MEMBER)`.
+
+## Clients
+
+The library provides two client implementations:
+
+* **`ZosmfClient`**: The standard synchronous client for communicating with z/OSMF using username/password, tokens, or standard TLS certificate files.
+* **`ZosmfZcryptoClient`**: A specialized client for z/OS environments that extracts mutual TLS (mTLS) client certificates directly from SAF key rings (RACF, ACF2, Top Secret).
+
+### Platform Support
+
+| Client | Linux | macOS | Windows | z/OS USS |
+| --- | :---: | :---: | :---: | :---: |
+| `ZosmfClient` | ✅ | ✅ | ✅ | ✅ |
+| `ZosmfZcryptoClient` | ❌ | ❌ | ❌ | ✅ |
+
+### Using `ZosmfZcryptoClient` on z/OS
+
+![ZosmfZcryptoClient demo](docs/ZosmfZcryptoClient.gif)
+
+`ZosmfZcryptoClient` retrieves client certificates and private keys directly from a SAF key ring, exporting temporary PEM files and configuring mutual TLS transparently. When using a key ring owned by the current user, specify the ring name as "name". When using a key ring owned by another user, specify the ring name as "userid/name":
+
+```python
+from zosmfrestapi import ZosmfZcryptoClient
+
+with ZosmfZcryptoClient("https://zosmf.example",
+                        keyring="userid/name", label="zOSMF Client Certificate") as client:
+    systems = client.get_systems()
+```
+
+Install the optional `zcrypto` extra:
+
+```console
+python -m pip install "zosmfrestapi[zcrypto]"
+```
+
+> [!WARNING]
+> The `zcrypto` extra requires `py_zcrypto`, a C extension that compiles against z/OS System SSL C headers. Therefore, it can **only** be installed and executed on **z/OS** systems. Attempting to install or use `ZosmfZcryptoClient` on Linux, macOS, or Windows will raise a `RuntimeError`.
+
+
+
+## Authentication and TLS
+
+The client uses the server's normal TLS certificate checks by default. Keep
+those checks enabled for routine use. The HTTP transport is HTTPX2; HTTPX2 uses `truststore`
+to integrate operating-system certificate stores when it creates its default TLS context.
+zosmfrestapi currently passes its own context, created with Python's
+`ssl.create_default_context()`, so the certificates available to Python are used.
+If the z/OSMF server's CA is no trusted in that environment, pass its certificate file
+with `cafile` below.
+
+| Situation | Client option |
+| --- | --- |
+| User ID and password | `username="...", password="..."` |
+| Client certificate and key in separate files | `cert=("client.crt", "client.key")` |
+| Client certificate and key in one PEM file | `cert="client.pem"` |
+| Internal certificate authority | `cafile="company-ca.pem"` |
+| Existing LTPA or JWT token | `ltpa_token="..."` or `jwt_token="..."` |
+| Identity propagation (needs [PH68412](https://www.ibm.com/support/pages/apar/PH68412))   | None |
+| Network proxy | `proxy="http://proxy.example.com:8080"` |
+
+For example, to trust an internal certificate authority, pass `cafile` when
+creating the client:
+
+```python
+with ZosmfClient("https://zosmf.example", username="demouser", password="itsasecret",
+                 cafile="company-ca.pem") as client:
+    systems = client.get_systems()
+```
+
+The `insecure=True` option disables TLS certificate verification; use it only for temporary
+diagnostics, never as a production fix. It cannot be combined with `cert` or `cafile`.
+
+## Supported APIs
+
+| API Category | Description | Key Methods (examples) |
+| --- | --- | --- |
+| **Authentication** | Basic Auth, LTPA / JWT tokens session login | `authenticate()` |
+| **Topology** | Query systems and sysplex groups defined in z/OSMF | `get_groups()`, `get_systems()` |
+| **Datasets** | Sequential and partitioned dataset retrieval | `read_dataset()` |
+| **Software Management** | SMP/E software instances, CSI queries, and datasets | `list_swis()`, `get_swi_by_name()`, `query_csi_by_name()` |
+| **Software Updates** | Search, inspect, start, monitor, and cancel update processes | `search_sw_updates_by_name()`, `start_sw_update_by_name()`, `check_sw_update_status()` |
+| **Workflows** | List, create, inspect, execute, monitor, and archive workflows | `get_workflows()`, `create_workflow()`, `start_workflow()`, `wait_for_workflow()` |
+
+Some operations change z/OSMF state. Check the method documentation and make
+sure your account has the required permissions before using them.
+
+## Troubleshooting
+
+* **Python version error:** install Python 3.12 or newer, then recreate the
+    virtual environment with that interpreter.
+* **401 / unauthorized:** check the server URL, user ID, password or token, and
+    whether the account is authorized for the requested API.
+* **Certificate verification error:** ask your z/OSMF administrator for the
+    correct CA certificate and pass its path with `cafile`.
+* **Connection or timeout error:** check that the server and port are reachable
+    from your machine and that any required proxy is configured.
+* **PowerShell will not activate the virtual environment:** use the Python
+    executable inside `.venv\Scripts\python.exe` to run commands, or follow your
+    organization's PowerShell policy guidance. Do not change the machine-wide
+    execution policy just to install this package.
+
+For the complete API, parameters, and return types, see the docstrings in the
+package source and the project website.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on development, testing, and submitting patches.
+
+## Issues and Feedback
+
+If you encounter any bugs or have feature requests, please report them on the [SourceHut issue tracker](https://todo.sr.ht/~ocurero/zosmfrestapi).
+
+## License
+
+The MIT License. See [LICENSE](LICENSE).
+
+## Trademarks
+
+IBM, the IBM logo, z/OS, MVS, and Z/OSMF are trademarks or are
+registered trademarks of International Business Machines Corporation,
+registered in many jurisdictions worldwide.  Other product and service
+names might be trademarks of IBM or other companies. A current list
+of IBM trademarks is available at <https://www.ibm.com/legal/copytrade>.
+
+This project is an independent community effort. It is not affiliated
+with, endorsed by, or sponsored by IBM.

{zosmfrestapi-0.2.0 → zosmfrestapi-0.3.0}/pyproject.toml

@@ -1,97 +1,112 @@
-[project]
-name = "zosmfrestapi"
-version = "0.2.0"
-description = "A Python wrapper for the z/OSMF REST API"
-readme = "README.md"
-authors = [
-    {name = "Oscar Curero",email = "dev@curero.es"}
-]
-license = "MIT"
-requires-python = ">=3.12"
-keywords = ["z/OSMF", "IBM Z", "mainframe", "REST API"]
-classifiers = [
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
-    "Topic :: Internet :: WWW/HTTP",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-]
-dependencies = [
-    "httpx2 (>=2.12.0,<3.0.0)",
-    "pendulum (>=3.2.0,<4.0.0)",
-    "dacite (>=1.9.2,<2.0.0)",
-]
-
-[project.urls]
-Homepage = "https://sr.ht/~ocurero/zosmfrestapi/"
-Repository = "https://sr.ht/~ocurero/zosmfrestapi/"
-PyPI = "https://pypi.org/project/zosmfrestapi/"
-
-[project.optional-dependencies]
-zcrypto = [
-    "py_zcrypto",
-]
-
-[dependency-groups]
-dev = [
-    "pytest (>=9.1.1,<10.0.0)",
-    "black (>=26.5.1,<27.0.0)",
-    "pytest-recording (>=0.14.0,<0.15.0)",
-    "pytest-httpx2 (>=1.0.0,<2.0.0)",
-    "pytest-cov (>=7.1.0,<8.0.0)",
-    "flake8 (>=7.5.0,<8.0.0)",
-    "flake8-pyproject (>=1.2.4,<2.0.0)",
-    "mypy (>=2.4.1,<3.0.0)",
-    "poethepoet (>=0.49.0,<0.50.0)",
-    "pyright (>=1.1.414,<2.0.0)",
-]
-zcrypto-dev = [
-    "cryptography (>=50.0.2,<51.0.0)"
-]
-
-[tool.black]
-line-length = 96
-
-[tool.flake8]
-max-line-length = 96
-extend-ignore = ["E203", "W503"]
-per-file-ignores = "tests/*.py:E501"
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-addopts = ["-ra",
-           "--record-mode=none",
-           "--cov-fail-under=100",
-           "--cov=zosmfrestapi",
-           ]
-
-
-[tool.poe.tasks]
-format = "black ."
-
-lint = [
-    { cmd = "black --check ." },
-    { cmd = "flake8" },
-    { cmd = "mypy zosmfrestapi" },
-    { cmd = "pyright --warnings" }
-
-]
-
-test = "pytest"
-
-check = [
-    { cmd = "black --check ." },
-    { cmd = "flake8 zosmfrestapi" },
-    { cmd = "pyright --warnings" },
-    { cmd = "mypy zosmfrestapi" },
-    { cmd = "pytest" }
-]
-
-[[tool.mypy.overrides]]
-module = ["OpenSSL.*", "py_zcrypto.*"]
-ignore_missing_imports = true
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
+[project]
+name = "zosmfrestapi"
+description = "A Python wrapper for the z/OSMF REST API"
+readme = "README.md"
+authors = [
+    {name = "Oscar Curero",email = "dev@curero.es"}
+]
+license = "MIT"
+requires-python = ">=3.12"
+keywords = ["z/OSMF", "IBM Z", "mainframe", "REST API"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx2 (>=2.12.0,<3.0.0)",
+    "pendulum (>=3.2.0,<4.0.0)",
+    "dacite (>=1.9.2,<2.0.0)",
+]
+dynamic = []
+version = "0.3.0"
+
+[project.urls]
+Homepage = "https://sr.ht/~ocurero/zosmfrestapi/"
+Repository = "https://git.sr.ht/~ocurero/zosmfrestapi"
+Issues = "https://todo.sr.ht/~ocurero/zosmfrestapi"
+PyPI = "https://pypi.org/project/zosmfrestapi/"
+
+[project.optional-dependencies]
+zcrypto = [
+    "py_zcrypto",
+]
+
+[dependency-groups]
+dev = [
+    "coverage (>=7.17.3,<8.0.0)",
+    "pytest (>=9.1.1,<10.0.0)",
+    "black (>=26.5.1,<27.0.0)",
+    "pytest-recording (>=0.14.0,<0.15.0)",
+    "pytest-httpx2 (>=1.0.0,<2.0.0)",
+    "flake8 (>=7.5.0,<8.0.0)",
+    "flake8-pyproject (>=1.2.4,<2.0.0)",
+    "mypy (>=2.4.1,<3.0.0)",
+    "poethepoet (>=0.49.0,<0.50.0)",
+    "pyright (>=1.1.414,<2.0.0)",
+]
+zcrypto-dev = [
+    "cryptography (>=50.0.2,<51.0.0)"
+]
+
+[tool.black]
+line-length = 96
+
+[tool.flake8]
+max-line-length = 96
+extend-ignore = ["E203", "W503"]
+per-file-ignores = "tests/*.py:E501"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+
+[tool.poe.groups.quality.tasks.format]
+help = "Format code acording to black."
+cmd = "black zosmfrestapi tests"
+
+[tool.poe.groups.quality.tasks.quality]
+help = "Run quality checks: black, flake8, mypy and pyright."
+sequence = [
+    { cmd = "black --check ." },
+    { cmd = "flake8 zosmfrestapi" },
+    { cmd = "mypy zosmfrestapi" },
+    { cmd = "pyright --warnings" }
+]
+
+[tool.poe.groups.testing.tasks.client_tests]
+help = "Run client tests only."
+sequence = [{cmd = """coverage run --omit='tests/*,*/zcrypto*' -m 
+                   pytest --ignore=tests/test_zcrypto_client.py"""},
+            {cmd = "coverage report --fail-under=100 --show-missing"}
+]
+
+[tool.poe.groups.testing.tasks.zcrypto_tests]
+help = "Run zcrypto tests only."
+sequence = [{cmd = """coverage run --omit='tests/*' --include='*/zcrypto*' -m
+                   pytest tests/test_zcrypto_client.py"""},
+            {cmd = "coverage report --fail-under=100 --show-missing"}
+            ]
+
+[tool.poe.groups.testing.tasks.tests]
+help = "Run client and zcrypto tests."
+sequence = ["client_tests", "zcrypto_tests"]
+
+[tool.poe.tasks.check]
+help = "Run all checks."
+sequence = ["quality", "client_tests", "zcrypto_tests"]
+
+[[tool.mypy.overrides]]
+module = ["OpenSSL.*", "py_zcrypto.*"]
+ignore_missing_imports = true
+
+[tool.poetry]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"

zosmfrestapi-0.3.0/zosmfrestapi/__init__.py

@@ -0,0 +1,11 @@
+"""Synchronous Python client for the z/OSMF REST API.
+
+The package root re-exports :class:`ZosmfClient` and :class:`ZosmfZcryptoClient`.
+Create one client per server/configuration and use it as a context manager to close
+the shared HTTP session when finished.
+"""
+
+from zosmfrestapi.client import ZosmfClient
+from zosmfrestapi.zcrypto_client import ZosmfZcryptoClient
+
+__all__ = ["ZosmfClient", "ZosmfZcryptoClient"]

zosmfrestapi-0.2.0/zosmfrestapi/utils.py → zosmfrestapi-0.3.0/zosmfrestapi/_utils.py

@@ -4,7 +4,7 @@ from typing import Any
 import pendulum
 
 
-def _parse_datetime(value: str) -> pendulum.DateTime:
+def parse_datetime(value: str) -> pendulum.DateTime:
     """Parse a string and require a Pendulum ``DateTime`` result.
 
     Args:

zosmfrestapi-0.3.0/zosmfrestapi/exceptions/__init__.py

@@ -0,0 +1,21 @@
+from zosmfrestapi.exceptions.commons import ZosmfAuthError, ZosmfError
+from zosmfrestapi.exceptions.authentication import ZosmfLoginError
+from zosmfrestapi.exceptions.dataset import ZosmfDatasetNotFoundError
+from zosmfrestapi.exceptions.software import (
+    ZosmfSoftwareInstanceNotFoundError,
+    ZosmfSoftwareManagementError,
+    ZosmfSoftwareManagementRequestError,
+)
+from zosmfrestapi.exceptions.workflow import ZosmfWorkflowBaseError, ZosmfWorkflowError
+
+__all__ = [
+    "ZosmfDatasetNotFoundError",
+    "ZosmfError",
+    "ZosmfAuthError",
+    "ZosmfLoginError",
+    "ZosmfSoftwareManagementError",
+    "ZosmfSoftwareInstanceNotFoundError",
+    "ZosmfSoftwareManagementRequestError",
+    "ZosmfWorkflowBaseError",
+    "ZosmfWorkflowError",
+]