Skip to content

Commit

Permalink
Rename modules to spiffe and spiffe-tls
Browse files Browse the repository at this point in the history
Signed-off-by: Max Lambrecht <[email protected]>
  • Loading branch information
maxlambrecht committed Mar 24, 2024
1 parent 0f55776 commit dc29282
Show file tree
Hide file tree
Showing 111 changed files with 662 additions and 511 deletions.
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ ignore =
E402
statistics = True
doctests = True
exclude = pyspiffe/src/pyspiffe/proto
exclude = spiffe/src/spiffe/proto
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/pyspiffe"
directory: "/spiffe"
schedule:
interval: "daily"

- package-ecosystem: "pip"
directory: "/pyspiffe-tls"
directory: "/spiffe-tls"
schedule:
interval: "daily"
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Root Makefile for managing pyspiffe modules
# Root Makefile for managing spiffe modules

# Define module directories
CORE_DIR=./pyspiffe
TLS_DIR=./pyspiffe-tls
CORE_DIR=./spiffe
TLS_DIR=./spiffe-tls

.DEFAULT_GOAL := help

Expand Down
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,19 @@ structured into two main modules:

## Modules

### [pyspiffe](pyspiffe/README.md)
### [spiffe](spiffe/README.md)

`pyspiffe` is the foundational module of the `py-spiffe` library, offering key functionalities around SPIFFE
specification, including the Workload API client implementation, and handling of SVIDs (SPIFFE Verifiable Identity
Documents).
The `spiffe` module 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.

### [pyspiffe-tls (In Development)](pyspiffe-tls/README.md)
### [spiffe-tls (In Development)](spiffe-tls/README.md)

The `pyspiffe-tls` module, currently in development, is planned to provide TLS utilities that facilitate the easy
integration of SPIFFE identities into the TLS workflows of Python applications. This module will offer features such as
mutual TLS (mTLS) support, certificate validation, and automatic SVID fetching and renewal, aimed at simplifying secure
service-to-service communication using SPIFFE identities.
The `spiffe-tls` module, currently in development, will offer TLS utilities for Python applications. It aims to simplify
the use of SPIFFE identities in TLS contexts, including mutual TLS support and certificate validation. This module will
enhance secure communication by leveraging SPIFFE identities for authentication.

## Contributing

Contributions to both `pyspiffe` and the `pyspiffe-tls` modules are welcome! Please see
Contributions to both `spiffe` and the `spiffe-tls` modules are welcome! Please see
our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to the project.
63 changes: 0 additions & 63 deletions pyspiffe/src/pyspiffe/proto/workload_pb2.py

This file was deleted.

227 changes: 0 additions & 227 deletions pyspiffe/src/pyspiffe/proto/workload_pb2_grpc.py

This file was deleted.

2 changes: 1 addition & 1 deletion scripts/lock-dependencies.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

modules=("pyspiffe" "pyspiffe-tls")
modules=("spiffe" "spiffe-tls")

# Check if pyproject.toml is in the list of staged changes
if git diff --cached --name-only | grep -q 'pyproject.toml'; then
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion pyspiffe-tls/README.md → spiffe-tls/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# pyspiffe-tls
# spiffe-tls

**Module in Development**
Loading

0 comments on commit dc29282

Please sign in to comment.