Skip to content

Commit a3dfbda

Browse files
committed
docs(cli): update readme and ensure it is on pypi
Signed-off-by: JP-Ellis <[email protected]>
1 parent 0da628e commit a3dfbda

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

pact-python-cli/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This sub-package is part of the [Pact Python](https://github.com/pact-foundation
1111

1212
It is used by version 2 of Pact Python, and can be used to install the Pact CLI in Python environments.
1313

14+
The versionining of `pact-python-cli` is aligned with the Pact CLI versioning. For example, version `2.4.26.2` corresponds to Pact CLI version `2.4.26`, with the `.2` indicating that this is the third release of that Pact CLI version in the Python package (with the first release being `.0`).
15+
1416
## Installation
1517

1618
You can install this package via pip:
@@ -21,7 +23,9 @@ pip install pact-python-cli
2123

2224
## Contributing
2325

24-
Contributions to this package are generally not required as it contains minimal Python functionality and generally only requires updating the version number. To contribute to the Pact CLI itself, please refer to the [Pact Ruby Standalone repository](https://github.com/pact-foundation/pact-ruby-standalone).
26+
Contributions to this package are generally not required as it contains minimal Python functionality and generally only requires updating the version number. This is done by pushing a tag of the form `pact-python-cli/<version>` which will automatically trigger a release build in the CI pipeline.
27+
28+
To contribute to the Pact CLI itself, please refer to the [Pact Ruby Standalone repository](https://github.com/pact-foundation/pact-ruby-standalone).
2529

2630
For contributing to Pact Python, see the [main contributing guide](https://github.com/pact-foundation/pact-python/blob/main/CONTRIBUTING.md).
2731

pact-python-cli/pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
description = "Pact CLI bundle for Python"
44
name = "pact-python-cli"
55

6-
dynamic = ["version"]
7-
license = "MIT"
6+
dynamic = ["version"]
7+
keywords = ["pact", "cli", "pact-python", "contract-testing"]
8+
license = "MIT"
9+
readme = "README.md"
810

911
authors = [{ name = "Joshua Ellis", email = "[email protected]" }]
1012
maintainers = [{ name = "Joshua Ellis", email = "[email protected]" }]

0 commit comments

Comments
 (0)