midpoint-cli 1.3.0__tar.gz → 1.4.0__tar.gz

{midpoint-cli-1.3.0 → midpoint_cli-1.4.0}/PKG-INFO

@@ -1,19 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: midpoint-cli
-Version: 1.3.0
+Version: 1.4.0
 Summary: A command line client to Midpoint Identity Management system.
-Home-page: https://gitlab.com/alcibiade/midpoint-cli
+License: MIT
+License-File: LICENSE
 Author: Yannick Kirschhoffer
 Author-email: alcibiade@alcibiade.org
-License: MIT
+Maintainer: Yannick Kirschhoffer
+Maintainer-email: alcibiade@alcibiade.org
+Requires-Python: >=3.9.0,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: Topic :: System :: Systems Administration
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: System :: Systems Administration
+Requires-Dist: prompt-toolkit (>=3.0,<4.0)
+Requires-Dist: pygments (>=2.0,<3.0)
+Requires-Dist: requests (>=2.31,<3.0)
+Requires-Dist: rich (>=13.0,<14.0)
+Requires-Dist: tabulate (>=0.9,<0.10)
+Requires-Dist: unidecode (>=1.3,<2.0)
+Requires-Dist: urllib3 (>=2.0,<3.0)
+Project-URL: Repository, https://gitlab.com/alcibiade/midpoint-cli
 Description-Content-Type: text/markdown
-License-File: LICENSE
+
+![link=https://badge.fury.io/py/midpoint-cli](https://badge.fury.io/py/midpoint-cli.svg)
 
 ## Midpoint CLI
 
@@ -35,9 +53,9 @@ The client currently supports:
 
 Features currently under development:
 
-* Auto completion to search of IDs or task names
+* Auto-completion to search of IDs or task names
 * Improved task results display: retrieve and display a human readable status output
-* Any other tasks that would be sumbitted in the issue tracker of this project on Gitlab
+* Any other tasks that would be submitted in the issue tracker of this project on Gitlab
 
 The strong points of this project are:
 
@@ -136,6 +154,10 @@ Successfully installed args-0.1.0 certifi-2019.9.11 chardet-3.0.4 clint-0.5.1 id
 
 ### Development build
 
+Dependency management, build and test is managed using Python Poetry.
+
+To install Poetry, please refer to [the official Python Poetry website](https://python-poetry.org/).
+
 To install the current development version from GIT:
 
 ```bash
@@ -148,30 +170,34 @@ remote: Total 374 (delta 229), reused 299 (delta 175)
 Receiving objects: 100% (374/374), 62.84 KiB | 0 bytes/s, done.
 Resolving deltas: 100% (229/229), done.
 
-yk@lunar:~/dev$ pip3 install midpoint-cli/
-Processing ./midpoint-cli
-Collecting clint (from midpoint-cli===0.8-snapshot)
-Collecting requests (from midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/51/bd/23c926cd341ea6b7dd0b2a00aba99ae0f828be89d72b2190f27c11d4b7fb/requests-2.22.0-py2.py3-none-any.whl
-Collecting tabulate (from midpoint-cli===0.8-snapshot)
-Collecting args (from clint->midpoint-cli===0.8-snapshot)
-Collecting chardet<3.1.0,>=3.0.2 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl
-Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/e0/da/55f51ea951e1b7c63a579c09dd7db825bb730ec1fe9c0180fc77bfb31448/urllib3-1.25.6-py2.py3-none-any.whl
-Collecting certifi>=2017.4.17 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/18/b0/8146a4f8dd402f60744fa380bc73ca47303cccf8b9190fd16a827281eac2/certifi-2019.9.11-py2.py3-none-any.whl
-Collecting idna<2.9,>=2.5 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl
-Building wheels for collected packages: midpoint-cli
-  Running setup.py bdist_wheel for midpoint-cli ... done
-  Stored in directory: /home/yk/.cache/pip/wheels/2a/5a/d6/54312f2db19e2a44cea90e4e1c186e7c1beb7192b4974db759
-Successfully built midpoint-cli
-Installing collected packages: args, clint, chardet, urllib3, certifi, idna, requests, tabulate, midpoint-cli
-Successfully installed args-0.1.0 certifi-2019.9.11 chardet-3.0.4 clint-0.5.1 idna-2.8 midpoint-cli-0.7.0 requests-2.22.0 tabulate-0.8.5 urllib3-1.25.6
+yk@lunar:~/dev$ poetry install 
+Creating virtualenv midpoint-cli-54EjqR0S-py3.12 in /home/yk/.cache/pypoetry/virtualenvs
+Updating dependencies
+Resolving dependencies... (5.1s)
+
+Package operations: 13 installs, 0 updates, 0 removals
+
+  - Installing args (0.1.0)
+  - Installing certifi (2024.8.30)
+  - Installing charset-normalizer (3.3.2)
+  - Installing idna (3.10)
+  - Installing iniconfig (2.0.0)
+  - Installing packaging (24.1)
+  - Installing pluggy (1.5.0)
+  - Installing urllib3 (2.2.3)
+  - Installing clint (0.5.1)
+  - Installing pytest (8.3.3)
+  - Installing requests (2.32.3)
+  - Installing tabulate (0.9.0)
+  - Installing unidecode (1.3.8)
+
+Writing lock file
+
+Installing the current project: midpoint-cli (1.4.0.dev2)
+                
+yk@lunar:~/dev$ poetry run midpoint-cli --version
+Midpoint CLI Version 1.4.0.dev2
 
-yk@lunar:~/dev$ midpoint-cli -v
-Midpoint CLI Version 0.8-snapshot
 ```
 
 ### Anaconda
@@ -224,5 +250,6 @@ midpoint-1
 * Update revision in src/midpoint_cli/__init__.py
 * Commit and tag with corresponding version number
 * Generate markdown documentation: downdoc README.adoc
-* Build distribution: python setup.py sdist
-* Upload distribution to PyPI: twine upload dist/*
+* Build distribution: poetry build
+* Upload distribution to PyPI: poetry publish
+

{midpoint-cli-1.3.0 → midpoint_cli-1.4.0}/README.md

@@ -1,3 +1,5 @@
+![link=https://badge.fury.io/py/midpoint-cli](https://badge.fury.io/py/midpoint-cli.svg)
+
 ## Midpoint CLI
 
 This project is a command line client interface used to drive an Evolveum Midpoint identity management server.
@@ -18,9 +20,9 @@ The client currently supports:
 
 Features currently under development:
 
-* Auto completion to search of IDs or task names
+* Auto-completion to search of IDs or task names
 * Improved task results display: retrieve and display a human readable status output
-* Any other tasks that would be sumbitted in the issue tracker of this project on Gitlab
+* Any other tasks that would be submitted in the issue tracker of this project on Gitlab
 
 The strong points of this project are:
 
@@ -119,6 +121,10 @@ Successfully installed args-0.1.0 certifi-2019.9.11 chardet-3.0.4 clint-0.5.1 id
 
 ### Development build
 
+Dependency management, build and test is managed using Python Poetry.
+
+To install Poetry, please refer to [the official Python Poetry website](https://python-poetry.org/).
+
 To install the current development version from GIT:
 
 ```bash
@@ -131,30 +137,34 @@ remote: Total 374 (delta 229), reused 299 (delta 175)
 Receiving objects: 100% (374/374), 62.84 KiB | 0 bytes/s, done.
 Resolving deltas: 100% (229/229), done.
 
-yk@lunar:~/dev$ pip3 install midpoint-cli/
-Processing ./midpoint-cli
-Collecting clint (from midpoint-cli===0.8-snapshot)
-Collecting requests (from midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/51/bd/23c926cd341ea6b7dd0b2a00aba99ae0f828be89d72b2190f27c11d4b7fb/requests-2.22.0-py2.py3-none-any.whl
-Collecting tabulate (from midpoint-cli===0.8-snapshot)
-Collecting args (from clint->midpoint-cli===0.8-snapshot)
-Collecting chardet<3.1.0,>=3.0.2 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl
-Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/e0/da/55f51ea951e1b7c63a579c09dd7db825bb730ec1fe9c0180fc77bfb31448/urllib3-1.25.6-py2.py3-none-any.whl
-Collecting certifi>=2017.4.17 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/18/b0/8146a4f8dd402f60744fa380bc73ca47303cccf8b9190fd16a827281eac2/certifi-2019.9.11-py2.py3-none-any.whl
-Collecting idna<2.9,>=2.5 (from requests->midpoint-cli===0.8-snapshot)
-  Using cached https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl
-Building wheels for collected packages: midpoint-cli
-  Running setup.py bdist_wheel for midpoint-cli ... done
-  Stored in directory: /home/yk/.cache/pip/wheels/2a/5a/d6/54312f2db19e2a44cea90e4e1c186e7c1beb7192b4974db759
-Successfully built midpoint-cli
-Installing collected packages: args, clint, chardet, urllib3, certifi, idna, requests, tabulate, midpoint-cli
-Successfully installed args-0.1.0 certifi-2019.9.11 chardet-3.0.4 clint-0.5.1 idna-2.8 midpoint-cli-0.7.0 requests-2.22.0 tabulate-0.8.5 urllib3-1.25.6
+yk@lunar:~/dev$ poetry install 
+Creating virtualenv midpoint-cli-54EjqR0S-py3.12 in /home/yk/.cache/pypoetry/virtualenvs
+Updating dependencies
+Resolving dependencies... (5.1s)
+
+Package operations: 13 installs, 0 updates, 0 removals
+
+  - Installing args (0.1.0)
+  - Installing certifi (2024.8.30)
+  - Installing charset-normalizer (3.3.2)
+  - Installing idna (3.10)
+  - Installing iniconfig (2.0.0)
+  - Installing packaging (24.1)
+  - Installing pluggy (1.5.0)
+  - Installing urllib3 (2.2.3)
+  - Installing clint (0.5.1)
+  - Installing pytest (8.3.3)
+  - Installing requests (2.32.3)
+  - Installing tabulate (0.9.0)
+  - Installing unidecode (1.3.8)
+
+Writing lock file
+
+Installing the current project: midpoint-cli (1.4.0.dev2)
+                
+yk@lunar:~/dev$ poetry run midpoint-cli --version
+Midpoint CLI Version 1.4.0.dev2
 
-yk@lunar:~/dev$ midpoint-cli -v
-Midpoint CLI Version 0.8-snapshot
 ```
 
 ### Anaconda
@@ -207,5 +217,5 @@ midpoint-1
 * Update revision in src/midpoint_cli/__init__.py
 * Commit and tag with corresponding version number
 * Generate markdown documentation: downdoc README.adoc
-* Build distribution: python setup.py sdist
-* Upload distribution to PyPI: twine upload dist/*
+* Build distribution: poetry build
+* Upload distribution to PyPI: poetry publish

midpoint_cli-1.4.0/pyproject.toml

@@ -0,0 +1,143 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "midpoint-cli"
+version = "1.4.0"
+description = "A command line client to Midpoint Identity Management system."
+readme = "README.md"
+
+license = "MIT"
+authors = ["Yannick Kirschhoffer <alcibiade@alcibiade.org>"]
+maintainers = ["Yannick Kirschhoffer <alcibiade@alcibiade.org>"]
+repository = "https://gitlab.com/alcibiade/midpoint-cli"
+
+packages = [
+    { include = "midpoint_cli", from = "src" }
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Topic :: System :: Systems Administration",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14"
+]
+
+[tool.poetry.scripts]
+midpoint-cli = 'midpoint_cli:main'
+
+[tool.poetry.dependencies]
+python = "^3.9.0"
+tabulate = "^0.9"
+unidecode = "^1.3"
+requests = "^2.31"
+urllib3 = "^2.0"
+rich = "^13.0"
+prompt-toolkit = "^3.0"
+pygments = "^2.0"
+
+[tool.poetry.group.test.dependencies]
+pytest = "*"
+
+[tool.poetry.group.dev.dependencies]
+pytest-cov = "*"
+ruff = "*"
+mypy = "*"
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+exclude = [
+    ".git",
+    ".pytest_cache",
+    ".ruff_cache",
+    "__pycache__",
+    "build",
+    "dist",
+    "venv",
+    ".venv",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line too long (handled by formatter)
+]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+check_untyped_defs = true
+disallow_untyped_decorators = false
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+show_error_codes = true
+
+[[tool.mypy.overrides]]
+module = [
+    "tabulate.*",
+    "unidecode.*",
+    "requests.*",
+    "urllib3.*",
+]
+ignore_missing_imports = true
+
+[tool.coverage.run]
+source = ["src"]
+branch = true
+omit = [
+    "*/tests/*",
+    "*/test/*",
+    "*/__pycache__/*",
+    "*/venv/*",
+    "*/.venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+show_missing = true
+skip_covered = false
+precision = 2
+
+[tool.coverage.html]
+directory = "coverage_html_report"

midpoint_cli-1.4.0/src/midpoint_cli/__init__.py

@@ -0,0 +1,83 @@
+import importlib
+import importlib.metadata
+import logging
+import os
+import sys
+from argparse import ArgumentParser, RawTextHelpFormatter
+from configparser import ConfigParser
+
+from midpoint_cli.client import MidpointClient
+from midpoint_cli.prompt import MidpointClientPrompt
+from midpoint_cli.prompt.configuration import compute_client_configuration
+from midpoint_cli.prompt.console import ConsoleDisplay
+
+
+def main():
+    logging.basicConfig(level=logging.INFO)
+    logging.getLogger('urllib3.connectionpool').setLevel(logging.ERROR)
+
+    version = importlib.metadata.version('midpoint_cli')
+
+    MIDPOINT_ENVIRONMENT_VARS = ['MIDPOINT_URL', 'MIDPOINT_USERNAME', 'MIDPOINT_PASSWORD']
+
+    argument_parser = ArgumentParser(
+        description='An interactive Midpoint command line client.',
+        formatter_class=RawTextHelpFormatter,
+        epilog="""
+    Available commands:
+      get       Get an XML definition from the server from an existing OID reference.
+      put       Create/Update a server object based on an XML structure.
+      delete    Delete a server object based on its type and OID.
+
+      task      Manage server tasks.
+      resource  Manage resources on the server.
+
+      org       Manage organizations.
+      user      Manage users.
+
+    Server URL and credentials can also be stored in ~/.midpoint-cli.cfg, or read from environment variables MIDPOINT_URL,
+    MIDPOINT_USERNAME and MIDPOINT_PASSWORD.
+
+    Midpoint-cli version """
+        + version
+        + """, created and maintained by Yannick Kirschhoffer alcibiade@alcibiade.org
+    """,
+    )
+    argument_parser.add_argument(
+        '-v', '--version', help='Set the username to authenticate this session.', action='store_true'
+    )
+    argument_parser.add_argument(
+        '-u', '--username', help='Set the username to authenticate this session.', default=None
+    )
+    argument_parser.add_argument(
+        '-p', '--password', help='Set the password to authenticate this session.', default=None
+    )
+    argument_parser.add_argument('-U', '--url', help='Midpoint base URL', default=None)
+    argument_parser.add_argument('command', help='Optional command to be executed immediately.', nargs='?')
+    argument_parser.add_argument('arg', help='Optional command arguments.', nargs='*')
+
+    argument_namespace = argument_parser.parse_args(sys.argv[1:])
+
+    if argument_namespace.version:
+        print(f'Midpoint CLI Version {version}')
+        sys.exit(0)
+
+    config_parser = ConfigParser()
+    config_parser.read(['midpoint-cli.cfg', os.path.expanduser('~/.midpoint-cli.cfg')])
+
+    client_configuration = compute_client_configuration(
+        argument_namespace, config_parser, [os.getenv(v) for v in MIDPOINT_ENVIRONMENT_VARS]
+    )
+
+    client = MidpointClient(client_configuration, observer=ConsoleDisplay())
+    prompt = MidpointClientPrompt(client)
+
+    if argument_namespace.command is not None:
+        prompt.onecmd(argument_namespace.command + ' ' + ' '.join(argument_namespace.arg))
+        sys.exit(prompt.error_code)
+    else:
+        prompt.cmdloop()
+
+
+if __name__ == '__main__':
+    main()