Skip to content

fvutils/pyucis

Repository files navigation

pyucis

Python API to Unified Coverage Interoperability Standard (UCIS) Data Model

Build Status PyPI version PyPI

Features

  • Python API for manipulating UCIS coverage databases
  • CLI Tools for database conversion, merging, and reporting
  • MCP Server for AI agent integration (see MCP_SERVER.md)
  • AgentSkills Support for enhanced AI agent understanding (see https://agentskills.io)
  • Support for XML, YAML, and UCIS binary formats
  • Multiple export formats: LCOV, Cobertura, JaCoCo, Clover

Installation

# Standard installation
pip install pyucis

# With MCP server support
pip install pyucis[dev]

Usage

Command Line Interface

# Convert coverage database
pyucis convert --input-format xml --output-format yaml input.xml -o output.yaml

# Merge multiple databases
pyucis merge db1.xml db2.xml db3.xml -o merged.xml

# Generate reports
pyucis report coverage.xml -o report.txt

# Query coverage information
pyucis show summary coverage.xml
pyucis show gaps coverage.xml --threshold 80
pyucis show covergroups coverage.xml

MCP Server for AI Agents

PyUCIS now includes a Model Context Protocol (MCP) server that enables AI agents to interact with coverage databases:

# Start the MCP server
pyucis-mcp-server

See MCP_SERVER.md for detailed documentation on:

  • Available MCP tools (17+ coverage analysis tools)
  • Integration with Claude Desktop and other AI platforms
  • API usage examples

AgentSkills Support

PyUCIS includes an AgentSkills skill definition that provides LLM agents with comprehensive information about PyUCIS capabilities. When you run any PyUCIS command, the absolute path to the skill file is displayed, allowing agents to reference it for better understanding of UCIS coverage data manipulation.

# Running any pyucis command displays the skill file location
pyucis --help
# Output includes: Skill Definition: /path/to/ucis/share/SKILL.md

Python API

from ucis import UCIS

# Open a database
db = UCIS("coverage.xml")

# Access coverage data
for scope in db.scopes():
    print(f"Scope: {scope.name}")
    for coveritem in scope.coveritems():
        print(f"  {coveritem.name}: {coveritem.count} hits")

Documentation

License

Apache 2.0

Links

About

Python API to Unified Coverage Interoperability Standard (UCIS) Data

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5