Metadata quality bot for software repositories, leveraging metacheck for analysis and GitHub/GitLab APIs for issue management.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tom.francois from gravatar.com tom.francois

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Tom François
  • Tags codemeta , metadata , bot , quality software
  • Requires: Python <3.13, >=3.10
  • Provides-Extra: dev , test , docs
Classifiers
Report project as malware

Project description

sw-metadata-bot

DOI License: MIT Version Python 3.10--3.12 CI (build) Code style: ruff coverage interrogate

An automated bot that analyzes repository metadata quality and creates issues with improvement suggestions.

Part of the CodeMetaSoft project to improve research software metadata quality.

📋 What This Bot Does

If you received an issue from this bot, it means your repository's metadata was automatically analyzed and some improvements were detected.

The issue contains:

  • Pitfalls: Critical metadata issues that should be fixed
  • Warnings: Metadata improvements that are recommended
  • Suggestions: Specific recommendations on how to fix each issue

Example Issues You Might See

  • Missing or incomplete LICENSE file
  • No CITATION.cff file (for software citation)
  • Incomplete or missing README sections
  • Missing repository metadata (topics, description, etc.)
  • Outdated dependencies
  • Missing software documentation

💬 How to Respond

If You Agree with the Suggestions

Fix the identified issues and close the issue with a comment explaining what you fixed. Your improvements help your software become more discoverable and citable!

If You Disagree or Have Questions

Feel free to comment on the issue. We're happy to discuss the suggestions and help clarify what's needed.

If You're Not Interested

Simply comment "unsubscribe" on the issue and we'll remove your repository from future analysis.

🔍 What Analysis Is Used

This bot uses RSMetaCheck, which analyzes:

  • Software metadata completeness
  • Citation and documentation quality
  • Repository structure and best practices

The bot does not:

  • Modify your code or files
  • Make pull requests
  • Have access to your repository secrets

📚 Learn More

🛠️ For Maintainers Running This Bot

See CONTRIBUTING.md for setup and usage instructions.

The pipeline is config driven: one JSON file defines the repository list, issue message, inline opt-outs, and output layout.

Supported platforms:

  • ✅ GitHub.com
  • ✅ Gitlab.com

Future:

  • Self-hosted GitLab instances

📝 License

See LICENSE file.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tom.francois from gravatar.com tom.francois

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Author: Tom François
  • Tags codemeta , metadata , bot , quality software
  • Requires: Python <3.13, >=3.10
  • Provides-Extra: dev , test , docs
Classifiers

Release history Release notifications | RSS feed

0.4.3

0.4.2

0.4.1

This version

0.4.0

0.3.2

0.3.1

Download files

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

Source Distribution

sw_metadata_bot-0.4.0.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

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

sw_metadata_bot-0.4.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file sw_metadata_bot-0.4.0.tar.gz.

File metadata

  • Download URL: sw_metadata_bot-0.4.0.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sw_metadata_bot-0.4.0.tar.gz
Algorithm Hash digest
SHA256 c66bc064eb01430b51b11bf8278079d878d2213077e90498ae711194bb104f14
MD5 cbbb5dde1bb007684ffbb11175e1d484
BLAKE2b-256 def18092af3f359ee1f18165f5cd09e88ea02fdf182be1c35a4de8b69ceb355e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sw_metadata_bot-0.4.0.tar.gz:

Publisher: ci.yml on SoftwareUnderstanding/sw-metadata-bot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sw_metadata_bot-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sw_metadata_bot-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a8c8f807abb19360361dd8d94c2b377678d5fb0fea758784be0a0cb467197f8
MD5 ab6200457c029647f59974a7e7e21586
BLAKE2b-256 0b2fd49f4517a24f9802f662d458ce54c3857f9e23691f6a387d1fce3a3c70ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for sw_metadata_bot-0.4.0-py3-none-any.whl:

Publisher: ci.yml on SoftwareUnderstanding/sw-metadata-bot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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