{"id":23821358,"url":"https://github.com/returnstring/govyn","last_synced_at":"2025-10-05T22:56:36.333Z","repository":{"id":38182729,"uuid":"284678568","full_name":"returnString/govyn","owner":"returnString","description":"A tiny framework for writing async HTTP APIs in typed Python","archived":false,"fork":false,"pushed_at":"2023-03-06T01:19:01.000Z","size":120,"stargazers_count":2,"open_issues_count":8,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-15T20:16:03.024Z","etag":null,"topics":["async","http","json","openapi","python"],"latest_commit_sha":null,"homepage":"","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/returnString.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2020-08-03T11:10:28.000Z","updated_at":"2024-09-18T07:41:41.000Z","dependencies_parsed_at":"2025-01-02T08:39:23.523Z","dependency_job_id":"9dd8e8be-efc4-473e-93fe-26404f84b1ba","html_url":"https://github.com/returnString/govyn","commit_stats":{"total_commits":152,"total_committers":6,"mean_commits":"25.333333333333332","dds":0.381578947368421,"last_synced_commit":"4bbbbd2d777a1e7c2a5188e3b008ed8b8bfebacf"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/returnString/govyn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/returnString%2Fgovyn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/returnString%2Fgovyn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/returnString%2Fgovyn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/returnString%2Fgovyn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/returnString","download_url":"https://codeload.github.com/returnString/govyn/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/returnString%2Fgovyn/sbom","scorecard":{"id":772417,"data":{"date":"2025-08-11","repo":{"name":"github.com/returnString/govyn","commit":"4bbbbd2d777a1e7c2a5188e3b008ed8b8bfebacf"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"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":1,"reason":"Found 1/9 approved changesets -- score normalized to 1","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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/pypi.yaml:1","Warn: no topLevel permission defined: .github/workflows/tests.yaml:1","Info: no jobLevel write permissions found"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/pypi.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pypi.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/pypi.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/pypi.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/pypi.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/returnString/govyn/tests.yaml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:21","Warn: pipCommand not pinned by hash: .github/workflows/pypi.yaml:22","Warn: pipCommand not pinned by hash: .github/workflows/tests.yaml:32","Warn: pipCommand not pinned by hash: .github/workflows/tests.yaml:33","Warn: pipCommand not pinned by hash: .github/workflows/tests.yaml:35","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned"],"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: licence:0","Info: FSF or OSI recognized license: MIT License: licence:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 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-23T02:32:41.388Z","repository_id":38182729,"created_at":"2025-08-23T02:32:41.389Z","updated_at":"2025-08-23T02:32:41.389Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273996535,"owners_count":25204471,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"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":["async","http","json","openapi","python"],"created_at":"2025-01-02T08:39:12.859Z","updated_at":"2025-10-05T22:56:31.282Z","avatar_url":"https://github.com/returnString.png","language":"Python","readme":"# govyn\n![Tests](https://github.com/returnString/govyn/workflows/Tests/badge.svg) [![PyPI version](https://badge.fury.io/py/govyn.svg)](https://pypi.org/project/govyn) [![codecov](https://codecov.io/gh/returnString/govyn/branch/main/graph/badge.svg)](https://codecov.io/gh/returnString/govyn)\n\nA tiny framework for writing async HTTP APIs in typed Python.\n\n\u003e **govyn** (verb) - ask, inquire, query, question, request ([Cornish Dictionary](https://www.cornishdictionary.org.uk/#govyn))\n\n# Features\n- Async everywhere!\n- Method params as query string arguments\n- Dataclasses as request bodies\n- Authentication with principals and privileges\n- OpenAPI support with built-in routes:\n\t- `/openapi/schema`: OpenAPI v3 schema as JSON\n\t- `/openapi/swagger`: embedded [Swagger UI](https://swagger.io/tools/swagger-ui/) page for testing\n\t- `/openapi/redoc`: embedded [Redoc](https://redoc.ly/redoc) documentation page\n- Prometheus metrics support\n\n# Example\n```python\nfrom dataclasses import dataclass\nfrom typing import List\nfrom govyn import run\n\n@dataclass\nclass AddRequest:\n\tnumbers: List[int]\n\n@dataclass\nclass Response:\n\tresult: int\n\nclass CalculatorAPI:\n\t# run initialisation tasks, e.g. connecting to a database\n\tasync def startup(self) -\u003e None:\n\t\tpass\n\n\t# be a good citizen and dispose of things appropriately\n\tasync def shutdown(self) -\u003e None:\n\t\tpass\n\n\t# get_ methods take a query string\n\t# callers will receive a 400 Bad Request if they supply invalid values\n\tasync def get_add(self, a: int, b: int) -\u003e Response:\n\t\treturn Response(a + b)\n\n\t# post_ methods take a JSON request body\n\t# also type-checked according to the dataclass definition\n\tasync def post_add(self, req: AddRequest) -\u003e Response:\n\t\treturn Response(sum(req.numbers))\n\nrun(CalculatorAPI())\n```\n\nTry out the built-in Swagger UI on this [example Heroku deployment](https://govyn-demo.herokuapp.com/openapi/swagger), built from source available in the [govyn-demo](https://github.com/returnString/govyn-demo) repository!\n\nOr, run the server locally and hit it with curl:\n\n```bash\n\u003e curl \"http://localhost/add?a=10\u0026b=32\"\n{\"result\": 42}\n\u003e curl \"http://localhost/add\" -d '{ \"numbers\": [ 1000, 300, 30, 7 ] }'\n{\"result\": 1337}\n```\n\n# Installation\n```bash\n# from PyPI\npip install govyn\n\n# or directly from Git\npip install git+ssh://git@github.com/returnString/govyn.git\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freturnstring%2Fgovyn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freturnstring%2Fgovyn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freturnstring%2Fgovyn/lists"}