{"id":21528201,"url":"https://github.com/znsio/specmatic-order-api-python","last_synced_at":"2025-03-17T18:44:42.562Z","repository":{"id":160420051,"uuid":"635301423","full_name":"znsio/specmatic-order-api-python","owner":"znsio","description":"Python port of Specmatic Order Api","archived":false,"fork":false,"pushed_at":"2025-03-08T00:55:16.000Z","size":100,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-08T01:30:39.438Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/znsio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2023-05-02T12:03:55.000Z","updated_at":"2025-03-08T00:55:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"6358e5e4-195e-44e9-b9d4-5c743ef6b440","html_url":"https://github.com/znsio/specmatic-order-api-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znsio%2Fspecmatic-order-api-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znsio%2Fspecmatic-order-api-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znsio%2Fspecmatic-order-api-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znsio%2Fspecmatic-order-api-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/znsio","download_url":"https://codeload.github.com/znsio/specmatic-order-api-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244091674,"owners_count":20396664,"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-24T01:52:09.079Z","updated_at":"2025-03-17T18:44:42.542Z","avatar_url":"https://github.com/znsio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Specmatic Sample: Python-Flask Order API\n\n* [Specmatic Website](https://specmatic.io)\n* [Specmatic Documentation](https://specmatic.io/documentation.html)\n\nThis sample project illustrates the implementation of contract-driven development and contract testing within a Flask (Python) application. In this context, Specmatic is utilized to function as a client, making calls to API service according to its OpenAPI specification to validate  its functionality.\n\nHere is the API's [contract/open api spec](https://github.com/znsio/specmatic-order-contracts/blob/main/io/specmatic/examples/store/openapi/api_order_v3.yaml)\n\n## Tech\n\n1. Flask\n2. Specmatic\n3. PyTest\n4. Coverage\n\n## Setup\n\n1. Install [Python 3.12](https://www.python.org/)\n2. Install JRE 17 or later.\n\n## Setup Virtual Environment\n\n1. ### Create a virtual environment named \".venv\" by executing the following command in the terminal from the project's root directory\n\n   ```shell\n    python -m venv .venv\n    ```\n\n2. ### Activate virtual environment by executing\n\n* **on MacOS and Linux**\n\n   ```shell\n   source .venv/bin/activate\n   ```\n\n* **on Windows CMD**\n\n  ```cmd\n  .venv\\Scripts\\activate.bat\n  ```\n\n* **on Windows Powershell (you may need to adjust the ExecutionPolicy)**\n\n  ```powershell\n  .\\.venv\\Scripts\\Activate.ps1\n  ```\n\n## Install Dependencies\n\nTo install all necessary dependencies for this project, navigate to the project's root directory in your terminal and execute\n\n```shell\npip install -r requirements.txt\n```\n\n## Execute Tests and Validate Contracts with Specmatic\n\nExecuting this command will initiate Specmatic and execute the tests on the Flask application.\n\n```shell\npytest test -v -s\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fznsio%2Fspecmatic-order-api-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fznsio%2Fspecmatic-order-api-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fznsio%2Fspecmatic-order-api-python/lists"}