{"id":14979091,"url":"https://github.com/materials-marketplace/standard-app-api","last_synced_at":"2025-07-01T05:39:11.831Z","repository":{"id":37093691,"uuid":"495445895","full_name":"materials-marketplace/standard-app-api","owner":"materials-marketplace","description":"Standard application API","archived":false,"fork":false,"pushed_at":"2025-06-23T17:33:32.000Z","size":86,"stargazers_count":2,"open_issues_count":11,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-06-23T18:39:26.215Z","etag":null,"topics":["fastapi","python"],"latest_commit_sha":null,"homepage":null,"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/materials-marketplace.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-23T14:28:43.000Z","updated_at":"2022-08-31T12:46:53.000Z","dependencies_parsed_at":"2023-02-09T03:15:30.703Z","dependency_job_id":"76f9d070-a918-4795-ba8a-56e8a979bed9","html_url":"https://github.com/materials-marketplace/standard-app-api","commit_stats":{"total_commits":67,"total_committers":10,"mean_commits":6.7,"dds":0.6119402985074627,"last_synced_commit":"1a8f94210473296a443ca77f6b6631d0fbba2d22"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/materials-marketplace/standard-app-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materials-marketplace%2Fstandard-app-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materials-marketplace%2Fstandard-app-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materials-marketplace%2Fstandard-app-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materials-marketplace%2Fstandard-app-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/materials-marketplace","download_url":"https://codeload.github.com/materials-marketplace/standard-app-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/materials-marketplace%2Fstandard-app-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261538408,"owners_count":23174100,"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":["fastapi","python"],"created_at":"2024-09-24T13:59:12.752Z","updated_at":"2025-07-01T05:39:11.770Z","avatar_url":"https://github.com/materials-marketplace.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README\n\n## About\n\nThis repository contains the specification of the Materials MarketPlace Standard App API.\nThe API is used as basis for the interaction between apps on the Materials MarketPlace platform.\n\nThis repository contains the API version: 0.6.0.\n\n## Authors\n\n- Simon Adorf (simon.adorf@epfl.ch)\n- MarketPlace consortium partners\n\n## Specification\n\nThe repository contains both a programmatic definition of the API (implemented via [Pydantic](https://pydantic-docs.helpmanual.io/) and [FastAPI](https://fastapi.tiangolo.com/)) within the [marketplace_standard_app_api.main](marketplace_standard_app_api/__main__.py) module as well as an equivalent [OpenAPI](https://www.openapis.org/) representation in the [openapi.json](openapi.json) file.\nProgrammatic checks are performed to ensure that both representations remain synchronized and conflict-free.\nIn case that the definition within the Python module and the OpenAPI JSON-file are conflicting with each other for whatever reason, the former must be considered authoritive.\n\nTip: You can use the `marketplace-standard-app-api show` command to generate the OpenAPI file from the Python module (requires the `cli` extra).\n\n## Installation\n\nNote: Users should use the [MarketPlace Python SDK](https://github.com/materials-marketplace/python-sdk) for app development.\n\nYou can install this package from PyPI with:\n```console\npip install marketplace-standard-app-api\n```\n\n## Tests\n\nTests for this repository are implemented via [pytest](https://pytest.org/).\nTo run these tests, first install the test dependencies with\n```console\npip install '.[tests]'\n```\nand then run the tests with the `pytest` command.\n\n## Contributing\n\nContributions in the form of issues, comments, and pull request are very welcome.\n\nTo make code contributions, please fork this repository, and then create a pull request.\nFor development you will need to setup a Python environment (with a recent Python version), install the development requiremments, and the pre-commit hooks with:\n```console\npip install pre-commit==2.17.0\npre-commit install\n```\n\n## For maintainers\n\nTo create a new release, clone the repository, install development dependencies with `pip install -e '.[dev]'`, and then execute `bumpver update --[major|minor|patch]`.\nThis will:\n\n  1. Create a tagged release with bumped version and push it to the repository.\n  2. Trigger a GitHub actions workflow that creates a GitHub release and publishes it on PyPI.\n\nAdditional notes:\n\n  - The project follows semantic versioning.\n  - Use the `--dry` option to preview the release change.\n\n## Acknowledgements\n\nThis work is supported by the MarketPlace project funded by [Horizon 2020](https://ec.europa.eu/programmes/horizon2020/) under the H2020-NMBP-25-2017 call (Grant No. 760173).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterials-marketplace%2Fstandard-app-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaterials-marketplace%2Fstandard-app-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaterials-marketplace%2Fstandard-app-api/lists"}