Rename modules to spiffe and spiffe-tls (HewlettPackard#148)

Signed-off-by: Max Lambrecht <[email protected]>

Author: maxlambrecht

.flake8

@@ -12,4 +12,4 @@ ignore =
     E402
 statistics = True
 doctests = True
-exclude = pyspiffe/src/pyspiffe/proto
+exclude = spiffe/src/spiffe/proto

.github/dependabot.yml

@@ -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"

Makefile

@@ -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
 

README.md

@@ -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.

pyspiffe/src/pyspiffe/proto/workload_pb2.py

@@ -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

pyspiffe/src/pyspiffe/proto/workload_pb2_grpc.py

@@ -1,3 +1,3 @@
-# pyspiffe-tls
+# spiffe-tls
 
 **Module in Development**