tanu/funpdbe-validator

Fork 0

Forked from https://gitlab.ebi.ac.uk/pdbe-kb/funpdbe/funpdbe-validator.git as part of my collaboration to submit my variant annotations, extended work from my PhD. https://thesis.tunstall.in

Find a file

mvaradi 7d89f1131b Small refactoring and docs		2018-10-14 10:31:40 +01:00
data	Updating the test paths	2018-10-12 17:53:13 +01:00
tests	Small refactoring and docs	2018-10-14 10:31:40 +01:00
validator	Small refactoring and docs	2018-10-14 10:31:40 +01:00
.gitignore	Renaming	2018-10-12 17:34:23 +01:00
.travis.yml	Requirements and Travis config	2018-10-12 17:26:24 +01:00
LICENSE	Initial commit	2018-10-12 17:25:07 +01:00
README.md	Adding Readme	2018-10-12 18:04:48 +01:00
requirements.txt	Adding residue index validator	2018-10-13 20:07:54 +01:00

README.md

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 the FunPDBe initiative, 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

Running the tests

Running tests for the client is performed simply by using

$ pytest tests

Versioning

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

Authors

Mihaly Varadi - Initial work - mvaradi

See also the list of contributors who participated in this project.

License

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