https://github.com/rdk/funpdbe-validator
forked from https://gitlabci.ebi.ac.uk/pdbe-kb/funpdbe/funpdbe-validator.git
https://github.com/rdk/funpdbe-validator
Last synced: 11 months ago
JSON representation
forked from https://gitlabci.ebi.ac.uk/pdbe-kb/funpdbe/funpdbe-validator.git
- Host: GitHub
- URL: https://github.com/rdk/funpdbe-validator
- Owner: rdk
- License: other
- Created: 2019-01-17T16:28:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-26T20:11:11.000Z (about 7 years ago)
- Last Synced: 2025-04-04T12:11:12.963Z (about 1 year ago)
- Language: Python
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
FunPDBe JSON Validator
======================
This Python3 client can be used for validating FunPDBe JSON files. It performs various sanity checks, and validates user JSONs against the FunPDBe schema.
For more information on FunPDBe is, visit https://funpdbe.org
Quick start
-----------
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Please note that the client is written in Python3, and the dependencies have to be installed accordingly (i.e. using pip3)!
### Installing
#### Checking out this repository
```
$ git clone https://github.com/funpdbe-consortium/funpdbe-validator
$ cd funpdbe-validator
$ pip3 install -r requirements.txt
```
### Basic usage
This package contains two classes which handle the validation of FunPDBe JSON files.
* Validator()
* ResidueIndexes()
Example:
```
from validator.validator import Validator
from validator.residue_index import ResidueIndexes
validator = Validator("funpdbe_resource_name") # Same as in the JSON
validator.load_schema("data/funpdbe_schema.json")
validator.load_json("data/funpdbe_data.json")
if validator.basic_checks() and validator.validate_against_schema():
# Passed data validations
residue_indexes = ResidueIndexes(validator.json_data)
if residue_indexes.check_every_residue():
# Passed the index validation
return True
```
### Running the tests
Running tests for the client is performed simply by using
```
$ pytest tests
```
## Versioning
We 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).
## Authors
* **Mihaly Varadi** - *Initial work* - [mvaradi](https://github.com/mvaradi)
See also the list of [contributors](https://github.com/funpdbe-consortium/funpdbe-validator/graphs/contributors) who participated in this project.
## License
This project is licensed under the EMBL-EBI License - see the [LICENSE](LICENSE) file for details