{"id":34094362,"url":"https://github.com/nykodetherapeutics/nydok","last_synced_at":"2026-04-07T11:31:33.125Z","repository":{"id":173064046,"uuid":"647639380","full_name":"nykodetherapeutics/nydok","owner":"nykodetherapeutics","description":"nydok is a combined specification writing and testing framework, for producing consistent and traceable specification documents.","archived":false,"fork":false,"pushed_at":"2025-05-14T14:02:52.000Z","size":824,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-25T07:44:52.834Z","etag":null,"topics":["csv","gamp5","gxp","markdown","pytest-plugin","specification"],"latest_commit_sha":null,"homepage":"https://nykodetherapeutics.github.io/nydok/","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/nykodetherapeutics.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":"2023-05-31T08:00:57.000Z","updated_at":"2025-05-15T07:39:51.000Z","dependencies_parsed_at":"2023-06-29T22:52:59.265Z","dependency_job_id":null,"html_url":"https://github.com/nykodetherapeutics/nydok","commit_stats":null,"previous_names":["nykodetherapeutics/nydok"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/nykodetherapeutics/nydok","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nykodetherapeutics%2Fnydok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nykodetherapeutics%2Fnydok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nykodetherapeutics%2Fnydok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nykodetherapeutics%2Fnydok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nykodetherapeutics","download_url":"https://codeload.github.com/nykodetherapeutics/nydok/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nykodetherapeutics%2Fnydok/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31511556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["csv","gamp5","gxp","markdown","pytest-plugin","specification"],"created_at":"2025-12-14T15:02:50.727Z","updated_at":"2026-04-07T11:31:33.120Z","avatar_url":"https://github.com/nykodetherapeutics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/nykodetherapeutics/nydok/raw/main/docs/assets/nydok-logo.png\" width=\"70%\"\u003e\n\u003c/div\u003e\n\n[![Main](https://github.com/nykodetherapeutics/nydok/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/nykodetherapeutics/nydok/actions/workflows/main.yml) [![PyPI version](https://badge.fury.io/py/nydok.svg)](https://badge.fury.io/py/nydok)\n\n[Home page](https://nykodetherapeutics.github.io/nydok/) | [Getting started](https://nykodetherapeutics.github.io/nydok/intro/)\n\n**nydok** is a combined specification writing and testing framework, for producing consistent and traceable specification documents. It is developed for Computerized Systems Validation in a GAMP 5 / GxP context, but is applicable to any software development process where traceability is important.\n\nWrite your requirements and risk assessment alongside your Python code, ensuring 1:1 mapping between requirements and the code you're writing.\n\nIt is implemented as a plugin for `py.test` for running the tests, combined with a CLI for creating reports.\n\n## Features\n\nSome notable features are:\n\n- Lets you write specification documents including requirements as normal Markdown.\n- Keeps track of which requirements are missing test cases.\n- Supports a risk assessment process where you can link mitigations to your requirements.\n- Can generate several types of reports in Markdown format for use in a Computerized System Validation process, such as:\n    - Traceability matrix\n    - Code review reports (Gitlab)\n    - Risk assessment report\n    - Test summary report\n    - CI pipeline logs report (Gitlab)\n\n\n## Installation\n\n\n**Note!** nydok is still under development and hasn't yet had a v1.0.0 release, so expect breaking changes.\n\n\nTo install nydok using `pip`:\n\n```\npip install nydok\n```\n\nor using Poetry:\n\n```\npoetry add nydok --group dev\n```\n\n## Usage\n\nSee documentation for details on how to use nydok, the following is just meant as a quick glimpse of how it works. nydok has a lot more features than what is shown here.\n\nCreate a `cowsay.spec.md` specification file:\n\n```markdown\n# Cowsay functional specification\n\n## Functional requirements\n\n- REQ001: The program must take as input a text string\n- REQ002: The program must return a string with a cow in ASCII art, displaying the input text as a speech bubble\n```\n\nand a `test_cowsay.py` file:\n\n```python\nfrom nydok import testcase\nimport cowsay\n\n\n@testcase([\"REQ001\", \"REQ002\"])\ndef test_cowsay():\n    assert cowsay(\"Hello world\") == \"\"\"\n     _____________\n    \u003c Hello world \u003e\n     -------------\n        \\   ^__^\n         \\  (oo)\\_______\n            (__)\\       )\\/\\\n                ||----w |\n                ||     ||\n    \"\"\"\n\n```\n\nNext, run `py.test` to check the specification:\n\n```\n$ py.test --nydok-output nydok.json cowsay/\n========================= test session starts =========================\nplatform linux -- Python 3.10.6, pytest-6.2.5, py-1.11.0, pluggy-1.0.0\nrootdir: /project\nplugins: nydok-0.8.0\ncollected 3 items\n\ncowsay/test_cowsay.py::test_cowsay PASSED                       [ 33%]\ncowsay/cowsay.spec.md::REQ001 PASSED                            [ 66%]\ncowsay/cowsay.spec.md::REQ002 PASSED                            [100%]\n\n========================== 3 passed in 0.01s ==========================\n```\n\nEach requirement listed in the specification file is counted as a test item, and will pass or fail depending on it's test case.\n\nFinally, run `nydok report` to generate reports.\n\nAs an example, to create a traceability matrix, run:\n\n```\n$ nydok report traceability-matrix nydok.json\n```\n\nto generate the following Markdown table:\n\n\nID     | Description                                                                                          | References | Test case\n------ | ---------------------------------------------------------------------------------------------------- | ---------- | ---------\nREQ001 | The program must take as input a text string                                                         |            | TC001\nREQ002 | The program must return a string with a cow in ASCII art, displaying the input text as a speech bubble |            | TC001\n\n## License\n\n`nydok` is released under the MIT license. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnykodetherapeutics%2Fnydok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnykodetherapeutics%2Fnydok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnykodetherapeutics%2Fnydok/lists"}