{"id":18008499,"url":"https://github.com/rdk/funpdbe-validator","last_synced_at":"2025-07-16T09:41:10.457Z","repository":{"id":182564854,"uuid":"166258249","full_name":"rdk/funpdbe-validator","owner":"rdk","description":"forked from https://gitlabci.ebi.ac.uk/pdbe-kb/funpdbe/funpdbe-validator.git","archived":false,"fork":false,"pushed_at":"2019-03-26T20:11:11.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-04T12:11:12.963Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rdk.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":"2019-01-17T16:28:49.000Z","updated_at":"2019-03-10T18:02:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"7b1681e7-c1e3-4333-8508-a9f2533db8ae","html_url":"https://github.com/rdk/funpdbe-validator","commit_stats":null,"previous_names":["rdk/funpdbe-validator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rdk/funpdbe-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdk%2Ffunpdbe-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdk%2Ffunpdbe-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdk%2Ffunpdbe-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdk%2Ffunpdbe-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdk","download_url":"https://codeload.github.com/rdk/funpdbe-validator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdk%2Ffunpdbe-validator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265500634,"owners_count":23777521,"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-10-30T01:18:56.306Z","updated_at":"2025-07-16T09:41:10.436Z","avatar_url":"https://github.com/rdk.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"FunPDBe JSON Validator\n======================\n\nThis Python3 client can be used for validating FunPDBe JSON files. It performs various sanity checks, and validates user JSONs against the FunPDBe schema.\n\nFor more information on FunPDBe is, visit https://funpdbe.org\n\nQuick start\n-----------\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nPlease note that the client is written in Python3, and the dependencies have to be installed accordingly (i.e. using pip3)!\n\n### Installing\n\n#### Checking out this repository\n\n```\n$ git clone https://github.com/funpdbe-consortium/funpdbe-validator\n$ cd funpdbe-validator\n$ pip3 install -r requirements.txt\n```\n\n### Basic usage\n\nThis package contains two classes which handle the validation of FunPDBe JSON files.\n\n* Validator()\n* ResidueIndexes()\n\nExample:\n```\nfrom validator.validator import Validator\nfrom validator.residue_index import ResidueIndexes\n\nvalidator = Validator(\"funpdbe_resource_name\") # Same as in the JSON\nvalidator.load_schema(\"data/funpdbe_schema.json\")\nvalidator.load_json(\"data/funpdbe_data.json\")\n\nif validator.basic_checks() and validator.validate_against_schema():\n    # Passed data validations\n    residue_indexes = ResidueIndexes(validator.json_data)\n    if residue_indexes.check_every_residue():\n        # Passed the index validation\n        return True\n```\n\n### Running the tests\n\nRunning tests for the client is performed simply by using\n```\n$ pytest tests\n```\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/funpdbe-consortium/funpdbe-validator/tags).\n\n## Authors\n\n* **Mihaly Varadi** - *Initial work* - [mvaradi](https://github.com/mvaradi)\n\nSee also the list of [contributors](https://github.com/funpdbe-consortium/funpdbe-validator/graphs/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the EMBL-EBI License - see the [LICENSE](LICENSE) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdk%2Ffunpdbe-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdk%2Ffunpdbe-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdk%2Ffunpdbe-validator/lists"}