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.21.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.21.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tracecov-0.21.0.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.21.0.tar.gz
Algorithm Hash digest
SHA256 3832f9a05e3cf0027e3d6c2fd10babe0d2ac76d1dd28c90077d9b619c6d128f0
MD5 74cbbe687114e227af7deabf220d2315
BLAKE2b-256 1042f47881a5c605021c9e4f5babb7057ee6ebe455c78cb277d3737d27cc794d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tracecov-0.21.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d69ac1755f4bf12a6ba6636c189828258c32f1df2691b9dc1069bd10adbbdae0
MD5 475b1bf29eff50918e061804b2a01747
BLAKE2b-256 6f80d58f543de25906e1630af1dd28eb6895d07d82a2d9a7fba45f38eb44a8e1

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