scim2-cli 0.1.0__tar.gz

scim2_cli-0.1.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: scim2-cli
+Version: 0.1.0
+Summary: SCIM application development CLI
+License: MIT
+Keywords: scim,scim2,provisioning
+Author: Yaal Coop
+Author-email: contact@yaal.coop
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: requests (>=2.32.2,<3.0.0)
+Requires-Dist: sphinx-click-rst-to-ansi-formatter (>=0.1.0,<0.2.0)
+Description-Content-Type: text/markdown
+
+# scim2-cli
+
+A scim utility command line.
+

scim2_cli-0.1.0/README.md

@@ -0,0 +1,3 @@
+# scim2-cli
+
+A scim utility command line.

scim2_cli-0.1.0/pyproject.toml

@@ -0,0 +1,121 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "scim2-cli"
+version = "0.1.0"
+description = "SCIM application development CLI"
+authors = ["Yaal Coop <contact@yaal.coop>"]
+license = "MIT"
+readme = "README.md"
+keywords = ["scim", "scim2", "provisioning"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "License :: OSI Approved :: MIT License",
+    "Environment :: Web Environment",
+    "Programming Language :: Python",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+click = "^8.1.7"
+requests = "^2.32.2"
+sphinx-click-rst-to-ansi-formatter = "^0.1.0"
+
+[tool.poetry.group.doc]
+optional = true
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.1"
+pytest-coverage = "^0.0"
+pytest-httpserver = "^1.0.10"
+
+[tool.poetry.group.doc.dependencies]
+shibuya = "^2024.5.15"
+sphinx = "^7.3.7"
+sphinx-click = "^6.0.0"
+myst-parser = "^3.0.1"
+
+[tool.poetry.scripts]
+scim = "scim2_cli:cli"
+scim2 = "scim2_cli:cli"
+
+[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 = [
+    "E", # pycodestyle
+    "F", # pyflakes
+    "I", # isort
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501", # line-too-long
+    "E722", # bare-except
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[too.ruff.format]
+docstring-code-format = true
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+isolated_build = true
+skipsdist = true
+envlist =
+    style
+    py310
+    py311
+    py312
+    doc
+    coverage
+
+[testenv]
+allowlist_externals = poetry
+commands =
+    poetry install
+    poetry run pytest --showlocals --full-trace {posargs}
+
+[testenv:style]
+commands =
+    pip install pre-commit
+    pre-commit run --all-files
+
+[testenv:doc]
+commands =
+    poetry install --with doc --without dev
+    poetry run sphinx-build --builder html doc build/sphinx/html
+    poetry run sphinx-build --builder man doc build/sphinx/html
+
+[testenv:coverage]
+commands =
+    poetry install
+    poetry run pytest --cov --cov-fail-under=100 --cov-report term:skip-covered {posargs}
+    poetry run coverage html
+"""

scim2_cli-0.1.0/scim2_cli/__init__.py

@@ -0,0 +1,129 @@
+import json
+
+import click
+import requests
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+DOC_URL = "https://scim2-cli.readthedocs.io/"
+BASE_HEADERS = {
+    "Accept": "application/scim+json",
+    "Content-Type": "application/scim+json",
+}
+
+
+@click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
+@click.argument("url")
+@click.pass_context
+def cli(ctx, url):
+    """SCIM application development CLI."""
+    ctx.ensure_object(dict)
+    ctx.obj["URL"] = url
+
+    if not click.get_text_stream("stdin").isatty():  # pragma: no cover
+        stdin = click.get_text_stream("stdin").read().strip()
+        ctx.obj["STDIN"] = json.loads(stdin)
+
+
+@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
+@click.pass_context
+def get(ctx):
+    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request.
+
+    Data passed in JSON format to stdin is sent as request arguments:
+
+    .. code-block:: bash
+
+        echo '{"foo": "bar"}' | scim https://scim.example get
+    """
+
+    response = requests.get(
+        ctx.obj["URL"],
+        params=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
+@click.pass_context
+def post(ctx):
+    """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request.
+
+    Data passed in JSON format to stdin is sent as request payload:
+
+    .. code-block:: bash
+
+        echo '{"foo": "bar"}' | scim https://scim.example post
+    """
+
+    response = requests.post(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
+@click.pass_context
+def put(ctx):
+    """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request.
+
+    Data passed in JSON format to stdin is sent as request payload:
+
+    .. code-block:: bash
+
+        echo '{"foo": "bar"}' | scim https://scim.example put
+    """
+
+    response = requests.put(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
+@click.pass_context
+def patch(ctx):
+    """Perform a `SCIM PATCH <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2>`_ request.
+
+    Data passed in JSON format to stdin is sent as request payload:
+
+    .. code-block:: bash
+
+        echo '{"foo": "bar"}' | scim https://scim.example patch
+    """
+
+    response = requests.patch(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
+@click.pass_context
+def delete(ctx):
+    """Perform a `SCIM DELETE <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
+
+    Data passed in JSON format to stdin is sent as request payload:
+
+    .. code-block:: bash
+
+        echo '{"foo": "bar"}' | scim https://scim.example delete
+    """
+
+    response = requests.delete(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)