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.

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) 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.0.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.0-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for eth_datacite_validator-0.1.0.tar.gz
Algorithm Hash digest
SHA256 68d8a57b3805cb62665214ebe21b73117a659d740a17fd74ef82b8a5e1ff00cc
MD5 b8f06f4fbe3752d9fb7a88e18caf784d
BLAKE2b-256 1d0b8f2d24a7377cca0bbcb64cc285874eb2b8beb0982b0f6634c3fe929aeb7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for eth_datacite_validator-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8dbac24b429ecba55ca6e62d1da213f17d1bc067d512218ace499d3072888ff9
MD5 5eee7a20c95cb84ab50442cf5f8a200a
BLAKE2b-256 6d662d77e6c07d4d24a001b9ac3e0c54b8ddcd5a53eacd522e2050fdf987b08b

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