Skip to main content

Tool for creating and verifying consumer-driven contracts using the Pact framework.

Project description

Pact Python

Pact Python Mascot Fast, easy and reliable testing for your APIs and microservices.
Package Version Python Versions Downloads
CI/CD Test Status Build Status Build Status
Meta Hatch project linting - Ruff style - Ruff types - Mypy License
Community Issues Discussions GitHub Stars
Slack Stack Overflow Twitter
Pact is the de-facto API contract testing tool. Replace expensive and brittle end-to-end integration tests with fast, reliable and easy to debug unit tests.
  • ⚡ Lightning fast
  • 🎈 Effortless full-stack integration testing - from the front-end to the back-end
  • 🔌 Supports HTTP/REST and event-driven systems
  • 🛠️ Configurable mock server
  • 😌 Powerful matching rules prevents brittle tests
  • 🤝 Integrates with Pact Broker / PactFlow for powerful CI/CD workflows
  • 🔡 Supports 12+ languages

Why use Pact? Contract testing with Pact lets you:

  • ⚡ Test locally
  • 🚀 Deploy faster
  • ⬇️ Reduce the lead time for change
  • 💰 Reduce the cost of API integration testing
  • 💥 Prevent breaking changes
  • 🔎 Understand your system usage
  • 📃 Document your APIs for free
  • 🗄 Remove the need for complex data fixtures
  • 🤷‍♂️ Reduce the reliance on complex test environments

Watch our series on the problems with end-to-end integrated tests, and how contract testing can help.

Documentation

This readme provides a high-level overview of the Pact Python library. For detailed documentation, please refer to the full Pact Python documentation. For a more general overview of Pact and the rest of the ecosystem, please refer to the Pact documentation.

Documentation for the API is generated from the docstrings in the code which you can view at pact-foundation.github.io/pact-python/pact.

Need Help

Installation

The latest version of Pact Python can be installed from PyPi:

pip install pact-python
# 🚀 now write some tests!

Requirements

Pact Python tries to support all versions of Python that are still supported by the Python Software Foundation. Older version of Python may work, but are not officially supported.

In order to support the broadest range of use cases, Pact Python tries to impose the least restrictions on the versions of libraries that it uses.

Telemetry

In order to get better statistics as to who is using Pact, we collect some anonymous telemetry. The only things we record are your type of OS, and the version information for the package. No personally identifiable information is sent as part of this request. You can disable telemetry by setting the environment variable PACT_DO_NOT_TRACK=1:

Contributing

We welcome contributions to the Pact Python library in many forms. There are many ways to help, from writing code, to providing new examples, to writing documentation, to testing the library and providing feedback. For more information, see the contributing guide.

Table of contributors

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pact_python-3.2.1.tar.gz (79.5 kB view details)

Uploaded Source

Built Distribution

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

pact_python-3.2.1-py3-none-any.whl (93.9 kB view details)

Uploaded Python 3

File details

Details for the file pact_python-3.2.1.tar.gz.

File metadata

  • Download URL: pact_python-3.2.1.tar.gz
  • Upload date:
  • Size: 79.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pact_python-3.2.1.tar.gz
Algorithm Hash digest
SHA256 bf6d9709999650feae49a085080fca95d2c1d6f94913fff8f2a6d6b9446b978d
MD5 4ef3b2cb0594bb20226e83e9112aba04
BLAKE2b-256 d3d2c8c769f0f323b6a8743da62d4603b94a1abac72783a36dab966be59d93b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pact_python-3.2.1.tar.gz:

Publisher: build.yml on pact-foundation/pact-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pact_python-3.2.1-py3-none-any.whl.

File metadata

  • Download URL: pact_python-3.2.1-py3-none-any.whl
  • Upload date:
  • Size: 93.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pact_python-3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2902fe74da09093269cf69d007227ae15db854abb22be7520ed643efa182b42e
MD5 33369f8088410ddeb58795217446ee6f
BLAKE2b-256 8196056bcc7e664e91868eb6d75669973df4c1d00a4f9848e2f640f153387e93

See more details on using hashes here.

Provenance

The following attestation bundles were made for pact_python-3.2.1-py3-none-any.whl:

Publisher: build.yml on pact-foundation/pact-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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