Conversation
This file contains hidden or 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
1 participant
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.
This pull request introduces significant improvements to the project, focusing on modernizing the codebase, enhancing documentation, and improving developer and user experience. The changes include a new Docker build workflow, updated documentation for contributors and users, a migration plan for future development, modernization of project metadata, and code style improvements.
Key changes:
Continuous Integration & Deployment:
.github/workflows/nightly.yml) to build and push a nightly Docker image, supporting workflow dispatch with branch selection and Docker cache optimization.Documentation & Contributor Experience:
CONTRIBUTING.mdwith guidelines on code style, architecture, error handling, security, testing, and pull request process.MIGRATION.mdoutlining CLI refactoring, user experience improvements, dual-protocol support, and a roadmap for a future TypeScript SDK.README.mdto reflect new dependencies, installation steps, usage instructions, project structure, and links to the new organization and documentation.Containerization:
Dockerfilefor running the CLI in a Python 3.12-slim container, supporting modern deployment workflows.Project Metadata & Licensing:
__metadata.pyto reflect new authorship, version (2.0.0), and repository URL under CIRCLE Cyber.LICENSEfile to the new copyright holder and year. (F62ba4e0L1)Code Quality:
client.py, including docstrings, type hints, argument parsing, and formatting for better maintainability.