Skip to main content

Validator for ETH DataCite metadata standards

Project description

DataCite XML Validator CLI

This is a simple Python CLI tool to validate DataCite files in XML format against the ETH Zurich metadata standards. This tool has been tested with Python version 3.8 to 3.13, it works for 3.10 to 3.13. The standards were based on DataCite version 4.6, the validator officially supports DataCite version 4.6 and 4.7.

Results

  • If your XML file does not comply with the agreed upon standards, it will not continue to throw warnings.
  • If your file complies with the standards, it will then get checked against our recommendations. These are called warnings.
  • You can also opt to just get the result.

Installation

Clone the repository and open the folder.

(Optional) Create a virtual environment:

python -m venv .venv
# On Unix/macOS:
source .venv/bin/activate
# On Windows:
.venv\Scripts\activate

Then simply install the project:

pip install .

Usage

Within your python environment run the CLI tool with:

(python) eth-validate-datacite <file-path>

Note that this package has the functions validate_datacite_from_file and validate_datacite_from_doi which can be used in scripts.

Flags

We are providing three flags:

  • --skip-warnings will not check for any warnings (recommendations will not be checked)
  • --hide-warnings will only give you the amount of warnings found, it will hide the actual warnings
  • --result-only will only show you the result, not any info on the actual errors or warnings.

License

MIT License

Author

Developed by Yasmin Waldeck at WSL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eth_datacite_validator-0.1.3.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eth_datacite_validator-0.1.3-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file eth_datacite_validator-0.1.3.tar.gz.

File metadata

  • Download URL: eth_datacite_validator-0.1.3.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for eth_datacite_validator-0.1.3.tar.gz
Algorithm Hash digest
SHA256 7e21698a29d003c2d9b5d5e69cdc345e9823098808cdba6db6be7d77f028a102
MD5 a8424ac3e74906e71b84209672143658
BLAKE2b-256 5c4e79deb46d7b73dc8b1b1267a26d0940d4a042d200181575d4777a4817fc0a

See more details on using hashes here.

File details

Details for the file eth_datacite_validator-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for eth_datacite_validator-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 68fd8f50b14c3821f089e462d433058cac5e888296c3b1a3759c142af6e3dab3
MD5 67b4568e49ab7ec7af6a5a6808bef969
BLAKE2b-256 13ef76fde8fd3f5975bdf863379829eb73c5625b90c5569b18dc3f8478379ea5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page