{"id":19310005,"url":"https://github.com/cedadev/compliance-check-maker","last_synced_at":"2026-02-06T06:31:44.212Z","repository":{"id":66788722,"uuid":"96986491","full_name":"cedadev/compliance-check-maker","owner":"cedadev","description":"Tool to write project-specific plugins and data specifications for the IOOS compliance checker","archived":false,"fork":false,"pushed_at":"2018-06-22T13:22:00.000Z","size":75,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-07-26T23:35:51.519Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cedadev.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}},"created_at":"2017-07-12T08:54:49.000Z","updated_at":"2020-02-14T15:57:31.000Z","dependencies_parsed_at":"2023-07-31T13:34:48.873Z","dependency_job_id":null,"html_url":"https://github.com/cedadev/compliance-check-maker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cedadev/compliance-check-maker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcompliance-check-maker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcompliance-check-maker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcompliance-check-maker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcompliance-check-maker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cedadev","download_url":"https://codeload.github.com/cedadev/compliance-check-maker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cedadev%2Fcompliance-check-maker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29153863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T02:39:25.012Z","status":"ssl_error","status_checked_at":"2026-02-06T02:37:22.784Z","response_time":59,"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":[],"created_at":"2024-11-10T00:22:13.290Z","updated_at":"2026-02-06T06:31:44.193Z","avatar_url":"https://github.com/cedadev.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compliance Check Maker - a tool to write project-specific plugins and data specifications for the IOOS compliance checker\r\n\r\n## Overview\r\n\r\nMost data projects require that the products comply with some pre-agreed specification.\r\n\r\nThere is a need to:\r\n - provide a specification document to data providers\r\n - provide a compliance checking tool to validate products against the specification\r\n\r\nThis code-base scans in a set of \"checks\" in tab-separated variable (TSV) files and\r\nthen automatically writes:\r\n - an HTML specification document\r\n - the python stubs for modules that can be implemented as plugins within the\r\n   [IOOS compliance checker](https://github.com/ioos/compliance-checker)\r\n\r\n## Using the tool for your own project\r\n\r\nTo get this tool working with a new project, you need to do the following:\r\n\r\n 1. Copy the `project/example_proj` directory to a `project/\u003cyour_project\u003e`.\r\n 2. Edit the `project/\u003cyour_project\u003e/PROJECT_METADATA.json` file to reflect information\r\n    about your project.\r\n 3. Edit the `project/\u003cyour_project\u003e/CATEGORIES.json` file to reflect information about\r\n    the categories of \"checks\" that you want to build.\r\n 4. For each category of checks: write a `project/\u003cyour_project\u003e/\u003ccategory\u003e.txt` file\r\n    based on the structure of the `project/\u003cyour_project\u003e/example-category.txt` format.\r\n\r\n### The format of the TSV files\r\n\r\nEach TSV file must follow the structure of the `project/\u003cyour_project\u003e/global-attrs.txt`\r\nfile. This means that the header line should contain the following columns:\r\n\r\n - check_id: the short ID for each check\r\n - check_name: the name of the python class that runs the actual check\r\n - check_level: HIGH, MEDIUM or LOW (which equate to MUST, SHOULD, INFO) [OPTIONAL]\r\n - vocabulary_ref: an identifier for the controlled vocabulary to be looked up [OPTIONAL]\r\n - modifiers: specified key/value parameters to send into the check [OPTIONAL]\r\n - comments: notes to explain the purpose of context of the check [OPTIONAL]\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedadev%2Fcompliance-check-maker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcedadev%2Fcompliance-check-maker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcedadev%2Fcompliance-check-maker/lists"}