{"id":20314461,"url":"https://github.com/release-engineering/starmap-client","last_synced_at":"2025-08-09T06:10:13.553Z","repository":{"id":247781347,"uuid":"823194761","full_name":"release-engineering/starmap-client","owner":"release-engineering","description":"Client library to communicate with the StArMap service","archived":false,"fork":false,"pushed_at":"2025-03-31T16:49:29.000Z","size":688,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-31T17:47:46.669Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/release-engineering.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-02T15:02:42.000Z","updated_at":"2025-03-31T16:49:32.000Z","dependencies_parsed_at":"2024-07-10T15:44:31.394Z","dependency_job_id":"347bf6a2-02ca-4199-a921-53ff8f25ffcc","html_url":"https://github.com/release-engineering/starmap-client","commit_stats":null,"previous_names":["release-engineering/starmap-client"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-engineering%2Fstarmap-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-engineering%2Fstarmap-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-engineering%2Fstarmap-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/release-engineering%2Fstarmap-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/release-engineering","download_url":"https://codeload.github.com/release-engineering/starmap-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248447600,"owners_count":21105140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-14T18:15:27.184Z","updated_at":"2025-08-09T06:10:13.546Z","avatar_url":"https://github.com/release-engineering.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StArMap Client\n\nThe client implementation for _StArMap_ service,\nused by [release-engineering](https://github.com/release-engineering) publishing tools.\n\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/release-engineering/starmap-client/tox-test.yml)\n![GitHub Release](https://img.shields.io/github/v/release/release-engineering/starmap-client)\n[![PyPI version](https://badge.fury.io/py/starmap-client.svg)](https://badge.fury.io/py/starmap-client)\n\n- [Source](https://github.com/release-engineering/starmap-client)\n- [Documentation](https://release-engineering.github.io/starmap-client/)\n\n## Overview\n\nThe `StArMap Client` is a client library to communicate with the _StArMap_ service, which is used to map a VM image build to its respective cloud marketplace(s) destination(s).\n\nIt's written to support applications running on `Python \u003e= 3.10`.\n\nThis library has a minimum set of requirements (namely `attrs` and `requests`) and can be installed and used in any supported environment.\n\n## Documentation\n\nThe documentation of `StArMap Client` is [available here](https://release-engineering.github.io/starmap-client/).\n\n## Installation\n\nTo install this library go to the project's root directory and execute:\n\n```{bash}\n    pip install -r requirements.txt\n    pip install .\n```\n\n## Usage\n\nInitializing the client\n\n```{python}\n    # Import the library\n    from starmap_client import StarmapClient\n\n    # Instantiate the client\n    client = StarmapClient(url=\"https://starmap.engineering.redhat.com/\")\n```\n\nQuerying the destinations of an image:\n\n```{python}\n    # Both statements will return a starmap_client.models.QueryResponse \n    object\n\n    # Query by NVR\n    query_response = client.query_image(\"sample-product-1.0.0-sp.vhd.xz\")\n\n    # Query by Name, Version\n    query_response = client.query_image_by_name(name=\"sample-product\", version=\"1.0.0\")\n```\n\n## Development\n\n### Prerequisites\n\nThe versions listed below are the one which were tested and work. Other versions can work as well.\n\n- Install or create a `virtualenv` for `python` \u003e= 3.10\n- Install `tox` \u003e= 3.25\n\n### Dependency Management\n\nTo manage dependencies, this project uses [pip-tools](https://github.com/jazzband/pip-tools) so that\nthe dependencies are pinned and their hashes are verified during installation.\n\nThe unpinned dependencies are recorded in **setup.py** and the **requirements.txt** are regenerated\neach time `tox` runs. Alternatively you can run `tox -e pip-compile` manually\nto achieve the same result. To upgrade a package, use the `-P` argument of the `pip-compile` command.\n\nWhen installing the dependencies use the command `pip install --no-deps --require-hashes -r requirements.txt`.\n\nTo ensure the pinned dependencies are not vulnerable, this project uses [safety](https://github.com/pyupio/safety),\nwhich runs on every pull-request or can be run manually by `tox -e security`.\n\n### Coding Standards\n\nThe codebase conforms to the style enforced by `flake8` with the following exceptions:\n\n- The maximum line length allowed is 100 characters instead of 80 characters\n\nIn addition to `flake8`, docstrings are also enforced by the plugin `flake8-docstrings` with\nthe following exemptions:\n\n- D100: Missing docstring in public module\n- D104: Missing docstring in public package\n- D105: Missing docstring in magic method\n\nAdditionally, `black` is used to enforce other coding standards.\n\nTo verify that your code meets these standards, you may run `tox -e lint`.\n\nTo automatically format your code you man run `tox -e autoformat`.\n\n### Unit tests\n\nTo run unit tests use `tox -e py38,py39,py310,py311`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-engineering%2Fstarmap-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelease-engineering%2Fstarmap-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelease-engineering%2Fstarmap-client/lists"}