Validactylus

Description

Validactylus is a Python command line tool to validate structure and format of CSV data. The validation rules are specified in JSON Schema and retrieved from a central repository.

Table of Contents

• Installation and usage
• Contributing
• Authors
• License
• Citation
• Acknowledgments

Installation and usage

Installation from GitHub:

pip install git+https://github.com/eLTER-RI/validactylus.git

Usage

run from command line

Windows:

> py -m validate_elter

Linux:

$ python path/to/validate_elter.py

Examples

> py -m validate_elter testdata.csv -r data_mapping

trying to validate with a schema that won't be found in eLTER's central shema store: > py -m validate_elter testdata.csv -r inexistent_schema

elter_validate: error: argument -r/--rules: invalid choice: 'this_schema_doesnt_exist' (choose from 'data_mapping', 'data_observation', 'event', 'license', 'mapping', 'method', 'reference', 'sample', 'station')

Getting help

For users

run validate_elter.py with the -h flag

For developers

see /docs or visit GitHub page

Dependencies

see requirements.txt

Coding style

To maintain the quality and readability of our code, we follow certain coding standards. Contributors are expected to adhere to these guidelines when writing code for this project:

Python

• We follow the PEP 8 style guide for Python code. This includes guidelines on code layout, naming conventions, and best practices.
• Use 4 spaces per indentation level.

Tools for enforcing style

• For Python, consider using tools like flake8 or black to automatically check and format code.

Authors

Author	Affiliation	ORCID	e-mail
Ivo Offenthaler	Environment Agency Austria	0000-0001-5793-6641	validiraptor-dev@proton.me

License

• This project is licensed under the EUPL License - see the LICENSE file for details.

Acknowledgments

Development & maintenance funded through: