diff --git a/README.md b/README.md index b4aac4bd..9d65623e 100644 --- a/README.md +++ b/README.md @@ -3,36 +3,34 @@ [![CI](https://github.com/HewlettPackard/py-spiffe/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/HewlettPackard/py-spiffe/actions/workflows/build.yaml?branch=main) `py-spiffe` is a Python library designed to provide support for [SPIFFE](https://spiffe.io). The library is -structured into two main modules: - -## Modules +structured into two main packages: ### [spiffe](spiffe/README.md) -The `spiffe` module is the core of the `py-spiffe` library, implementing the SPIFFE specification. It provides +[![PyPI spiffe](https://badge.fury.io/py/spiffe.svg)](https://pypi.org/project/spiffe/) + +The `spiffe` package is the core of the `py-spiffe` library, implementing the SPIFFE specification. It provides functionality for managing SPIFFE identities, including the Workload API client and automatic handling of X.509 and -JWT SVIDs. This module simplifies working with SPIFFE identities by automating SVID fetching and renewal. +JWT SVIDs. This package simplifies working with SPIFFE identities by automating SVID fetching and renewal. + +### [spiffe-tls](spiffe-tls/README.md) (experimental) -### [spiffe-tls (Experimental)](spiffe-tls/README.md) +[![PyPI spiffe-tls](https://badge.fury.io/py/spiffe-tls.svg)](https://pypi.org/project/spiffe-tls/) -The `spiffe-tls` module is currently in experimental development and aims to provide Python applications with advanced +The `spiffe-tls` package is currently in experimental development and aims to provide Python applications with advanced TLS utilities. Its primary goal is to streamline the integration of SPIFFE identities into TLS contexts, facilitating not only mutual TLS configurations but also enhancing certificate validation processes. ## Installation -`spiffe` module: +You can install the `spiffe` and `spiffe-tls` packages directly from PyPI: -```sh +```bash pip install spiffe -``` - -`spiffe-tls` module: -```sh pip install spiffe-tls ``` ## Contributing -Contributions to both `spiffe` and the `spiffe-tls` modules are welcome! Please see +Contributions to both `spiffe` and the `spiffe-tls` packages are welcome! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to the project. diff --git a/spiffe-tls/README.md b/spiffe-tls/README.md index 08f5ad04..8fe6e9cc 100644 --- a/spiffe-tls/README.md +++ b/spiffe-tls/README.md @@ -1,6 +1,6 @@ -# `spiffe-tls` module (experimental) +# `spiffe-tls` package (experimental) -This `py-spiffe` module provides TLS utilities that facilitate creating secure TLS connections leveraging SPIFFE IDs for +This `py-spiffe` package provides TLS utilities that facilitate creating secure TLS connections leveraging SPIFFE IDs for authentication. It wraps [pyOpenSSL](https://pypi.org/project/pyOpenSSL/), offering easy-to-use functions for setting up TLS clients and servers with SPIFFE-based authentication using `X509Source` to manage and automatically update X.509 certificates and CA trusted bundles. @@ -53,7 +53,7 @@ conn = dial( ### Authorization Functions -The module supports custom authorization functions for additional certificate validation: +The package supports custom authorization functions for additional certificate validation: - `authorize_any()`: Authorizes any valid SPIFFE ID. - `authorize_id(expected_spiffe_id)`: Authorizes a specific SPIFFE ID. diff --git a/spiffe/README.md b/spiffe/README.md index eafe18e3..400da005 100644 --- a/spiffe/README.md +++ b/spiffe/README.md @@ -1,8 +1,8 @@ -# `spiffe` module +# `spiffe` package ## Overview -The `spiffe` module, part of the `py-spiffe` library, provides Python developers with essential tools for interacting +The `spiffe` package, part of the `py-spiffe` library, provides Python developers with essential tools for interacting with the [SPIFFE Workload API](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Workload_API.md). It streamlines the management and validation of SPIFFE identities, including support for both [X509-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/X509-SVID.md) @@ -11,7 +11,7 @@ and [SPIFFE Bundles](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE ## Usage -Below are examples demonstrating the core functionalities of the `spiffe` module. +Below are examples demonstrating the core functionalities of the `spiffe` package. Prerequisites: