Skip to content

CSCfi/metadata-submitter-tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

630 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python Unit Tests Python style check

Metadata submitter tools

XML Validation CLI

Command-line tool for validating a given XML file against a specific XSD Schema.

Installing

Note: The tool requires Python 3.11+

Clone the project and install with pip:

git clone https://github.com/CSCfi/metadata-submitter-tools.git
cd metadata-submitter-tools
pip install .

Tests

Tests can be executed with tox automation:

# Install tox first if not installed
pip install tox
# Run tests
tox

Usage

After installation, the validation tool is used by by executing xml-validate in a terminal with specified options/arguments followingly:

xml-validate <option> <xml-file> <schema-file>

The <xml-file> and <schema-file> arguments need to be the correct filenames (including path) of a local XML file and the corresponding XSD file. The <option> can be --help for showing help and -v or --verbose for delivering a detailed validation error message.

Below is a terminal demonstration of the usage of this tool, which displays the different outputs the CLI will produce:

asciicast

Packages/Libraries used

License

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

Contibuting

If you want to contribute to a project and make it better, your help is very welcome. For more info about how to contribute, see CONTRIBUTING.

About

Metadata submitter tools - validate XML against an XSD schema

Resources

License

Contributing

Stars

Watchers

Forks

Contributors

Languages