contractual

v0.4.6

Contractual provides a method for verifying the function of mocks across modules and projects For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

PyPI

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 39.19K
Forks: 2.47K
Contributors: 440

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package contractual, we found that it has been starred 39,186 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 11, 2019
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 363
Open PR: 31
Last Release: 5 years ago
Last Commit: 9 days ago

Further analysis of the maintenance status of contractual based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for contractual is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 440
Funding: No

A good and healthy external contribution signal for contractual project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7, <4

Age: 5 years
Latest Release: 5 years ago
Dependencies: N/A
Versions: 1
Maintainers: 1
Wheels: OS Independent

Readme

Contractual

Installation

pip install contractual

Use

how to use-

Contract Files

Contract files comply with the Pact file format seen at https://github.com/pact-foundation/pact-specification/tree/version-2 There is a key difference though-

Contractual supports mocking out arbitrary interfaces, while Pact limits itself to http requests. As such, a Contractual file can only be used with a Pact verifier if you limit the unchecked mocks to HttpContractMock. In the files themselves, you will see a list of interactions having the form

{
    "description": "get all users for max",
    "request": {},
    "response": {},
    "providerState": "a user with an id named 'u:ser' exists"
}

That is a valid HTTP contract. A more general ContractMock contract would have the form

{
    "description": "get all users for max",
    "contractMock": {
        "contractName": "Name",
        "args": []
    },
    "response": {},
    "providerState": "a user with an id named 'user' exists"
}

Development

Development Environment

Poetry is used to manage the project and dependencies. Once you have poetry installed pip install --user poetry, you can run poetry install to setup a virtaulenv for your project. Dependencies can be updated using poetry add or poetry remove and committing the updated pyproject.toml and poetry.lock files.

Release

CI is handled on Gitlab at https://gitlab.com/pjbecotte/contractual. There is a make target to create a new release by tagging a new version and then incrementing to the next beta version. (This requires permissions to push to master)

FAQs

What is contractual?

Contractual provides a method for verifying the function of mocks across modules and projects. Visit Snyk Advisor to see a full health score report for contractual, including popularity, security, maintenance & community analysis.

Is contractual popular?

The python package contractual receives a total of 22 weekly downloads. As such, contractual popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is contractual well maintained?

We found indications that contractual is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is contractual safe to use?

The python package contractual was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 November-2024, at 08:57 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP