Welcome to sw-metadata-bot’s documentation

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

Part of the CodeMetaSoft project.

Contents:

• Installation
  • Requirements
  • Install from PyPI
  • From source for contributors
• Usage
  • Command Line Interface
  • Example Workflow
  • Decision Tree for Issue Creation
• API Reference
  • Analysis Runtime Module
  • Check Parsing Module
  • Commit Lookup Module
  • Config Utils Module
  • Create Issues Module
  • GitHub API Module
  • GitLab API Module
  • History Module
  • Incremental Module
  • Main Module
  • MetaCheck Wrapper Module
  • Pipeline Module
  • Pitfalls Module
  • Publish Module
  • Token Resolver Module
  • Verify Tokens Module

Quick Start

Install from PyPI:

pip install sw-metadata-bot

Run analysis with a campaign configuration file:

sw-metadata-bot run-analysis --config-file path/to/config.json

Review the generated snapshot, then publish the approved results:

sw-metadata-bot publish --analysis-root outputs/<run_name>/<snapshot_tag>

For installation choices, configuration examples, and token setup, see Installation and Usage.

Indices and tables

• Index

• Module Index

• Search Page