Metadata quality bot for software repositories, leveraging metacheck for analysis and GitHub/GitLab APIs for issue management.
Project description
sw-metadata-bot
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 on the main default branch.
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
- Codemeta.json generation: if your repo does not contain any
codemeta.jsonfile, the bot suggests one.
Example Issues You Might See
### [P002](https://w3id.org/rsmetacheck/catalog/#P002)
**Evidence:** P002 detected: LICENSE file contains unreplaced template placeholders
**Suggestion:** Update the copyright section with accurate names, organizations, and the current year. Personalizing this section ensures clarity and legal accuracy.
💬 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
- CodeMetaSoft Project - About the initiative
- RSMetaCheck - The analysis tool
- Citation File Format - How to add CITATION.cff
🛠️ 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
The bot is handling self-hosted gitlab platform but requires providing a token to this server (and not gitlab.com).
📝 License
See LICENSE file.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sw_metadata_bot-0.4.2.tar.gz.
File metadata
- Download URL: sw_metadata_bot-0.4.2.tar.gz
- Upload date:
- Size: 55.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f965f4b1b3c9d87f0ce2e71045e23e76715661ffb9d23a18da03e1469379288b
|
|
| MD5 |
50fbeca9abaa80de69abb4459fc69df4
|
|
| BLAKE2b-256 |
7e7d926d2c17294f245dcab03fb70cc9b1c2e5678540a3dfc466790ac7bb924c
|
File details
Details for the file sw_metadata_bot-0.4.2-py3-none-any.whl.
File metadata
- Download URL: sw_metadata_bot-0.4.2-py3-none-any.whl
- Upload date:
- Size: 47.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb93aacea65caa1a183b0615854a3b0d78443b3f6abb57adb17b6671f72108f4
|
|
| MD5 |
bf91b4ccfb07ada75f4038ce218f56a6
|
|
| BLAKE2b-256 |
f5f41d240e44123daef27a603acb59f415de6305b06987833cd8a96180896c3e
|
