zarch / datapackage-validation

Submodule that can be used to validate a datapackage.json file for datasets. To use it just include it in the root of your dataset repository as submodule. You can then execute it using python3 running the file 'validate-datapackage.py'. The script will automatically look for the datapackage.json in the root of the repository.

Datapackage validation script

The script handles required attributes needed by the integration script.

If everything works fine the message "Validation OK" is printed in terminal. Otherwise it prints the errors detected.

Note that if the script declares that your repository is OK, it does not mean that the data itself is conform. It might still fail during the integration but this script minimizes the number of errors and prevents basic errors before pushing the dataset to GIT project.

How to include it in your repository

Open terminal and go to the root of your repository. Execute git command:

git submodule add https://github.com/HotMaps/datapackage-validation.git

Make sure you have the required dependencies with command:

pip install -r requirements.txt

You might need to use pip3 in some distributions.

Then execute script with command:

python datapackage-validation/validate_datapackage.py

You might need to use python3 in some distributions.

This script has been tested using python3 but might work with python2.