{"id":23511203,"url":"https://github.com/percolate/pedantic","last_synced_at":"2025-08-23T10:32:54.713Z","repository":{"id":148675306,"uuid":"155622535","full_name":"percolate/pedantic","owner":"percolate","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-16T18:02:48.000Z","size":24884,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-06-16T05:44:59.732Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"j-funk/pedantic","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/percolate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2018-10-31T20:58:29.000Z","updated_at":"2023-03-16T18:02:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"549ab7e1-5505-4d50-9f2e-a8b9e5ccdda9","html_url":"https://github.com/percolate/pedantic","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/percolate/pedantic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percolate%2Fpedantic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percolate%2Fpedantic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percolate%2Fpedantic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percolate%2Fpedantic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/percolate","download_url":"https://codeload.github.com/percolate/pedantic/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percolate%2Fpedantic/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271746653,"owners_count":24813575,"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-08-23T02:00:09.327Z","response_time":69,"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":[],"created_at":"2024-12-25T12:13:44.020Z","updated_at":"2025-08-23T10:32:54.696Z","avatar_url":"https://github.com/percolate.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# prclt/pedantic\n\n[![codecov](https://codecov.io/gh/percolate/pedantic/branch/master/graph/badge.svg)](https://codecov.io/gh/percolate/pedantic)\n\nPedantic allows any client to discover when a fixture no longer complies with a published API.\n\n## Who is Pedantic for?\n\nPedantic is for client maintainers (front end, mobile etc..) who wish to automatically maintain test fixtures against services with an API specification defined in **RAML 0.8**.\n\n### Rationale\n\nAssuming the client developers write automated tests, it is best that client tests do not make external HTTP requests during the test process since that can lead to non-deterministic test results.\nHTTP calls during testing are often avoided by creating mock requests in json.\nWhile mock fixtures prevent external calls during testing, they do not prevent or detect a service provider's API changes.\nWhen the API changes, tests which use outdated mocks continue to pass even though the actual client may no longer functions correctly.\n\nPedantic is a lightweight service designed to run on the same host as the test client and is accessible via `localhost`.\nProvide Pedantic with the API definition in RAML, then during testing send the fixture data to Pedantic.\nPedantic validates the fixture and sends its results back to the caller.\n\n## Usage\n\nDisplay CLI help\n\n```bash\ndocker run prclt/pedantic -h\n```\n\nBasic example caching (RAML/whitelist downloads) by mounting `:/tmp` as a volume:\n\n```bash\ndocker run --rm --publish 5000:5000 --volume $(pwd)/tmp:/tmp prclt/pedantic https://percolate.com/docs/api/index.raml\n```\n\n```bash\ncurl -X POST -i http://localhost:5000/ --data '{\n    \"method\": \"PUT\",\n    \"path_info\": \"/api/v5/user/user:1\",\n    \"query_string\": \"required_param=a_string,optional_param=1\",\n    \"status_code\": 200,\n    \"request\": {\"name\": \"John Smith\"},\n    \"response\": {\"data\": {\"name\": \"John Smith\"}}\n}' -H \"Content-Type: application/json\"\n```\n\n## Development\n\nBuild image locally\n\n```bash\nmake build\n```\n\nShell into `prclt/pedantic` with the repo mounted for development:\n\n```bash\nmake dev\n\n# from there you can run tests:\nbin/test\nbin/smoke_test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercolate%2Fpedantic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercolate%2Fpedantic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercolate%2Fpedantic/lists"}