{"id":19301330,"url":"https://github.com/dmpe/matrix42sdk","last_synced_at":"2026-06-18T17:31:14.746Z","repository":{"id":57440089,"uuid":"284247513","full_name":"dmpe/matrix42sdk","owner":"dmpe","description":"Python 3 Client SDK for Matrix42 Software Asset Management/Enterprise Service Management tool","archived":false,"fork":false,"pushed_at":"2021-07-03T17:50:29.000Z","size":103,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-02T07:59:40.452Z","etag":null,"topics":["api-client","client-sdk","matrix42","python3","rest","sdk"],"latest_commit_sha":null,"homepage":"https://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmpe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-01T11:33:37.000Z","updated_at":"2023-09-25T13:52:56.000Z","dependencies_parsed_at":"2022-09-19T14:21:10.463Z","dependency_job_id":null,"html_url":"https://github.com/dmpe/matrix42sdk","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dmpe/matrix42sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmpe%2Fmatrix42sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmpe%2Fmatrix42sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmpe%2Fmatrix42sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmpe%2Fmatrix42sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmpe","download_url":"https://codeload.github.com/dmpe/matrix42sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmpe%2Fmatrix42sdk/sbom","scorecard":{"id":348299,"data":{"date":"2025-08-11","repo":{"name":"github.com/dmpe/matrix42sdk","commit":"97a329214af6bfa2b838a45ac12820a519182d6f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 8 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T07:42:24.389Z","repository_id":57440089,"created_at":"2025-08-18T07:42:24.389Z","updated_at":"2025-08-18T07:42:24.389Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34501471,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","client-sdk","matrix42","python3","rest","sdk"],"created_at":"2024-11-09T23:17:33.141Z","updated_at":"2026-06-18T17:31:14.731Z","avatar_url":"https://github.com/dmpe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python 3 Matrix42 SDK for Enterprise Service Management (ESM) tool\n\n\"ERP for Software Asset Management\"\n\n[![matrix42sdk package in my-feed feed in Azure Artifacts](https://feeds.dev.azure.com/johnmalc/2efa647f-e5a5-4720-835d-4fc45fde9432/_apis/public/Packaging/Feeds/0c65acb4-f8ae-4df6-9f17-9db0f7687350/Packages/313927f6-82a5-4f2b-9bb0-9b90bcf3cec2/Badge)](https://dev.azure.com/johnmalc/Matrix42SDK/_packaging?_a=package\u0026feed=0c65acb4-f8ae-4df6-9f17-9db0f7687350\u0026package=313927f6-82a5-4f2b-9bb0-9b90bcf3cec2\u0026preferRelease=true)\n[![Build Status](https://dev.azure.com/johnmalc/Matrix42SDK/_apis/build/status/dmpe.matrix42sdk?branchName=master)](https://dev.azure.com/johnmalc/Matrix42SDK/_build/latest?definitionId=10\u0026branchName=master)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n![GitHub](https://img.shields.io/github/license/dmpe/matrix42sdk)\n![Pull Requests](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg)\n![GitHub repo size](https://img.shields.io/github/repo-size/dmpe/matrix42sdk)\n\n## The background story\n\nAs of July 2020, Matrix42 AG, a German company is offering a [Configuration Management Database (CMBD)](https://www.matrix42.com/en/enterprise-service-management) - basically a competing product to ServiceNOW and many others like Microsoft Intune.\n\nTheir Angular based product can be installed on-prem and used as ITIL supporting tool for the company.\n\nIt provides a REST API which this Python3+ SDK tries to cover.\nUnfortunately, Swagger support is currently not available which has led me to write this client package myself - becoming my first python3 client SDK.\n\nIt shows - also due to learning Python OOP principles.\n\n### Documentation of Rest API\n\n- \u003chttps://help.matrix42.com/030_DWP/030_INT\u003e Intro\n- \u003chttps://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations\u003e How to use the API\n- \u003chttps://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations/Matrix42_Web_Services_API\u003e Matrix42 Approach to the API\n- \u003chttps://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations/Web_Services%3A_Authentication_types\u003e Example of AuthN\n- \u003chttps://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations/Web_Services_tokens%3A_Generate_API_Token\u003e Generate API Token\n\nSetting up the Sphinx auto-generate documentation:\n\n- \u003chttps://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/\u003e\n\n# What works and what does not?\n\nWorks:\n\n- get and put (i.e. update) fragment\n\nUse Cases:\n\n- updating CI version numbers\n\nSemi/or not working:\n\n- creating fragment was not tested, but is implemented as a Rest API call\n- get and put object -\u003e here not tested extensively and one must expect bugs\n\n# Testing\n\nWithout having a Matrix42 ESM portal which allows API access and is publicly available for unlimited use,\nthe only option how to test this library is to use **your** own ESM portal installation (be it in public cloud or on prem).\nHence the need to use your own API keys, etc.\n\nFrom this follows that this library cannot - as of now - include more python tests, at least not publicly available.\nIt is my recommendation to write your `own, private tests` and report issues here.\n\nSorry for inconvenience!\n\n# Usage\n\n## Python 3 - Simple Testing\n\nUsing `requests` you can call\n\n```\nimport requests\n\nurl = \"https://xxxx/m42Services/api/ApiToken/GenerateAccessTokenFromApiToken/\"\n\npayload = {}\nheaders = {\n  'Content-Type': 'application/json',\n  'Authorization': 'Bearer the 'short' version of bearer token generated from Administration Panel in the GUI'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data = payload, verify = False)\n\nprint(response.text.encode('utf8'))\n\n# only then start using proper API requests\nimport requests\n\nurl = \"https://xxxx/m42Services/api/data/fragments/Ud_SoftwareproduktVersionClassBase/775c82cf-d243-4bfb-a1b2-f3edad93c826\"\n\npayload = {}\nheaders = {\n  'Authorization': 'Bearer \"output of the previous requests \"RawToken\" '\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data = payload)\n\nprint(response.text.encode('utf8'))\n```\n## Matrix42 SDK for Python\n\nTo use Matrix42 SDK, first decide which authN approach you are going to use.\n\nFor a **basic**, create a `Matrix42RestClient` object by using your (or any other matrix42 CMBD) account:\n\n```{python}\nimport matrix42sdk\nfrom matrix42sdk import Matrix42RestClient\nfrom matrix42sdk.api_endpoints import *\n```\n\nFor using `Access/API Tokens`, you can set your `MATRIX42SDK_API_TOKEN` via a shell (**higher priority**):\n\n```{shell}\nexport MATRIX42_URL=\"xxx\"\nexport MATRIX42SDK_API_TOKEN=\"xxx\"\n```\n\nand then:\n\n```{python3}\nmat = api_endpoints.fragments.FragmentsDataService()\n```\n\nThen to [get a fragment for a specific CI](https://help.matrix42.com/030_DWP/030_INT/Business_Processes_and_API_Integrations/Public_API_reference_documentation/Fragments_Data_Service%3A_Get_Fragment_data), insert correct parameters according to the documentation:\n\n```\nJUPYTERLAB_ID_FRAG = \"8c51cfff-bf16-452e-8d2c-527cc25518c3\"\nSYS_ENTITY = \"SPSSoftwareType\"\nfull_ci_frg = mat.get_fragement(SYS_FRAGEMENT, JUPYTERLAB_ID_FRAG)\n```\n\n## Documentation\n\nWe use \u003chttps://sphinx-rtd-theme.readthedocs.io/\u003e and \u003chttps://www.sphinx-doc.org/en/master/\u003e\n\n```\ncd docs\nsphinx-apidoc -o source ../matrix42sdk\nmake html\n```\n\n# Building this package yourself\n\nThis package is being build on Azure DevOps services:\n\n\u003chttps://dev.azure.com/johnmalc/Matrix42SDK/_build\u003e\n\nand further uses SonarCloud:\n\n\u003chttps://sonarcloud.io/dashboard?id=dmpe_matrix42sdk\u003e\n\nUse to install package from non-PyPI feed (the azure one):\n\n```\npip3 install --index https://pkgs.dev.azure.com/johnmalc/Matrix42SDK/_packaging/my-feed/pypi/simple/ matrix42sdk\n```\n\n## PyPI\n\n```\npoetry build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmpe%2Fmatrix42sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmpe%2Fmatrix42sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmpe%2Fmatrix42sdk/lists"}