Skip to main content

Documentation Status DOI PyPI - Version

Research Software MetaCheck (a Pitfall/Warning Detection Tool)

This project provides an automated tool for detecting common metadata quality issues (pitfalls & Warnings) in software repositories. The tool analyzes SoMEF (Software Metadata Extraction Framework) output files to identify various problems in repository metadata files such as codemeta.json, package.json, setup.py, DESCRIPTION, and others.

Overview

MetaCheck identifies 29 different types of metadata quality issues across multiple programming languages (Python, Java, C++, C, R, Rust). These pitfalls range from version mismatches and license template placeholders to broken URLs and improperly formatted metadata fields.

You can visit our catalog to see in details what these pitfalls are, where are they usually detected and how to fix them.

Supported Pitfall Types

The tool detects the following categories of issues:

  • Version-related pitfalls: Version mismatches between metadata files and releases
  • License-related pitfalls: Template placeholders, copyright-only licenses, missing version specifications
  • URL validation pitfalls: Broken links for CI, software requirements, download URLs
  • Metadata format pitfalls: Improper field formatting, multiple authors in single fields, etc...
  • Identifier pitfalls: Invalid or missing unique identifiers, bare DOIs
  • Repository reference pitfalls: Mismatched code repositories, Git shorthand usage

Requirements

  • Python 3.11
  • Required Python packages:
    • requests (for URL validation)
    • pathlib (built-in)
    • json (built-in)
    • re (built-in)
    • somef (For extracting metadata from the repositories)

Installation

  1. Clone the repository:

    git clone https://github.com/SoftwareUnderstanding/rsmetacheck.git
    cd rsmetacheck
    
  2. Install with Poetry:

    poetry install
    
  3. Configure SoMEF (optional but recommended): Initially, the installation process will run somef configure -a to automatically set it up and install the necessary packages but the rate limit will be low. If you need more, you should reconfigure SoMEF, you can run the following command:

    poetry run somef configure
    

    Then add your GitHub authentication token to avoid API rate limits when analyzing repositories in batches.

Using pip

Alternatively, you can install directly from GitHub:

pip install git+https://github.com/SoftwareUnderstanding/rsmetacheck.git

Usage

For full usage instructions — including CLI options, GitHub Action integration, GitLab CI/CD setup, output format, and configuration — please refer to the usage documentation.

Troubleshooting

Common Issues

  1. "There is no valid repository URL" error: Ensure the JSON file that contains the repositories has a valid structure and that you are inputing the correct path
  2. Network timeouts: Some pitfalls validate URLs and may time out this is normal behavior

Performance Notes

  • URL validation pitfalls may take longer due to network requests
  • Large datasets may require several minutes to complete analysis
  • Progress is displayed in real-time showing which pitfalls are found

Contributing

The system is designed with modularity in mind. Each pitfall detector is implemented as a separate module in the scripts/ directory, making it easy to add new pitfall types or modify existing detection logic.

Metadata

Release files for rsmetacheck 0.3.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rsmetacheck 0.3.8
File Size Uploaded Provenance Actions
rsmetacheck-0.3.8.tar.gz 56.4 kB Without provenance Details for rsmetacheck-0.3.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rsmetacheck 0.3.8
File Interpreter ABI Platform Actions
rsmetacheck-0.3.8-py3-none-any.whl Python 3 none any Details for rsmetacheck-0.3.8-py3-none-any.whl

Total release size: 134.7 kB

Release files / rsmetacheck-0.3.8.tar.gz

Download URL rsmetacheck-0.3.8.tar.gz
Size 56.4 kB
Tags Source
SHA-256 checksum
How to use checksums
5a705a43171ab77d089c5f8f1b45857774651217b3c907929bcd64b96b9c8a2b
BLAKE2b-256 checksum
How to use checksums
f8415e4a230af6d065e923177242fd4e8b63cedce1350822a2673c4339d91512
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.11.18 Linux/7.0.0-1019-azure

Release files / rsmetacheck-0.3.8-py3-none-any.whl

Download URL rsmetacheck-0.3.8-py3-none-any.whl
Size 78.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
00935b26ded5fb2c807e7c2a4a627ad19278393fbb14e8a2c41bb465b1d4577c
BLAKE2b-256 checksum
How to use checksums
a870696a46381b5f8ca76de7c365a85c63528e218617d203adced390c4125237
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.11.18 Linux/7.0.0-1019-azure

Security for rsmetacheck 0.3.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page