Refactor: Restructure Library, Introduce pyspiffe-tls Module, and Simplify Interface #146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description:
This PR introduces a comprehensive overhaul of the
py-spiffelibrary, aimed at improving usability, maintainability, and providing a foundation for future expansion. Here are the key changes and additions:Core Module Restructuring: I've restructured the
pyspiffecore module to make it more intuitive and easier to use.New pyspiffe-tls Module: Addition of the
pyspiffe-tlsmodule, currently in the initial stages of development. This module aims to supplement the core functionalities with TLS utilities, enabling seamless integration of SPIFFE identities into Python applications’ TLS workflows. Thepyspiffe-tlsmodule currently doesn't have any functionality, it's only the main folders and configuration files.Simplified Dependencies and Tooling: streamlined dependencies and tools.
Introduction of Type Re-exports: reducing the need for extensive import paths and simplifying codebases that utilize the library.
Codebase Cleanup: removed unnecessary files and outdated documentation.
Updated Documentation: The README for the
pyspiffecore module now includes usage instructions and examples.