Skip to main content

Schema-level API coverage down to individual keywords.

Project description

TraceCov

Schema-level API coverage down to individual keywords.

Your API tests pass. But did you actually test the validation rules?

Hitting POST /users with {"name": "Alice", "age": 30} gives you 100% endpoint coverage—but you haven't tested empty names, negative ages, or strings that are too long.

TraceCov measures coverage at the schema keyword level: minLength, pattern, enum, minimum - not just endpoints.

API Coverage Report

Install

pip install tracecov

Quick Start

import tracecov
import requests

# Load your OpenAPI schema
coverage = tracecov.CoverageMap.from_path("openapi.json")

# Wrap your session to track requests
session = coverage.requests.track_session(requests.Session())

# Run your tests as usual
session.post("https://api.example.com/users", json={"name": "Alice"})
session.get("https://api.example.com/users/123")

# Generate the report
coverage.save_report()

What It Tracks

Dimension What it measures
Operations HTTP method + path combinations called
Parameters Path, query, header, cookie, body coverage
Keywords JSON Schema validation rules (minLength, pattern, etc.)
Examples Schema examples and defaults used
Responses HTTP status codes returned

Documentation

https://docs.tracecov.sh/

Feedback

Help shape TraceCov: 2-minute survey

Professional Edition

For advanced features, contact info@tracecov.sh.

Project details


Download files

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

Source Distribution

tracecov-0.20.0.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

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

tracecov-0.20.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file tracecov-0.20.0.tar.gz.

File metadata

  • Download URL: tracecov-0.20.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • 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":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tracecov-0.20.0.tar.gz
Algorithm Hash digest
SHA256 e327de6279826392e8760303b79d111c5b1fedd8b0853fc0dbfd48bbc11f8c39
MD5 0d1a420b086ae3e2d670c0a307d256ab
BLAKE2b-256 88225ca7a3710e916baa5fe2ad51599c4272ea90e4209fa7fb86331d51729bd1

See more details on using hashes here.

File details

Details for the file tracecov-0.20.0-py3-none-any.whl.

File metadata

  • Download URL: tracecov-0.20.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • 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":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tracecov-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55a08fd0b8fc829fbec9cb45ffd0a8062dcba8218b611a2b7db625300ffbc934
MD5 99be95a1ed35cbe9e957ab2b3d814c32
BLAKE2b-256 7ca33d3fce8baf9f3248a21298f9aeec716ad147de7d08260e85c0fb6633d2e6

See more details on using hashes here.

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