Skip to content

PDBe-KB/funpdbe-schema

Repository files navigation

FunPDBe Data Exchange Format (JSON Schema)

Build Status codecov Maintainability

This is the repository of the FunPDBe JSON Schema

Quick start

There are two main files:

  • funpdbe_schema.json
  • funpdbe_example.json

There is also a very basic JSON validator that shows how to validate a JSON file against the schema:

# install dependencies
pip install -r requirements.txt

# run the validator
cd basic_validator
python3 basic_validator/basic_validator.py path/to/schema.json path/to/json/file.json

This will run a simple validation, using the jsonschema package. It will use the schema from the path "path/to/schema.json" and validate the json at the path "path/to/example.json" against it.

Schema

The JSON schema specifies all the details of the data exhange format that is used by FunPDBe. For more information on how JSON schemas work, please refer to http://json-schema.org/

Example

The file funpdbe_example.json is an example of a JSON file with data in a format that is acceptable by the FunPDBe deposition system.

Versioning

We use SemVer for versioning. For the versions available, see the tags.

Authors

  • Mihaly Varadi - Initial work - mvaradi

License

This project is licensed under the EMBL-EBI License - see the LICENSE file for details

Acknowledgments

We would like to thank the PDBe team for their support and feedback, as well as all the members of the FunPDBe consortium:

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages