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.2.tar.gz (24.0 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.2-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eth_datacite_validator-0.1.2.tar.gz
  • Upload date:
  • Size: 24.0 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.2.tar.gz
Algorithm Hash digest
SHA256 d6a61ccbeee5fe5c8b0579b6087f16ace220b04c159080b31372021f3cf8e9e1
MD5 ef7c90d45b11a6c27a58754a4036a692
BLAKE2b-256 f60067e81105c621e65a7ec037d11af72f3c2e59a095ab553b8d15f0cb9adb05

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for eth_datacite_validator-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e1cdc1c265ed5416262a78faec958fea30aace6c9a04b68db8d9f1e2a16bc1ce
MD5 b47b6a353309de45b718f923856417b4
BLAKE2b-256 ec3230bf09ef5458788fdc73a8e91a1a36ebee76430547758431b977321f468d

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