Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🛤️ Tracking: Python SDK #784

Open
1 of 6 tasks
j-lanson opened this issue Jan 14, 2025 · 0 comments
Open
1 of 6 tasks

🛤️ Tracking: Python SDK #784

j-lanson opened this issue Jan 14, 2025 · 0 comments
Assignees
Labels
product: python-sdk Relates to the Python plugin SDK status: needs-rfd This topic is big enough to require an RFD. tracking-issue This issue tracks a larger task. type: enhancement New feature or request

Comments

@j-lanson
Copy link
Collaborator

j-lanson commented Jan 14, 2025

We want to support a Python SDK for Hipcheck plugin writing, both to increase the accessibility of writing a custom plugin, and to test/ensure that our plugin comms protocol does not make any Rust-specific assumptions. We will first sketch out what a design would look like and create an SDK, then implement the design and test it with a new plugin (likely a dummy plugin). We will also need to ensure we document its usage and establish a release process.

Edit: also look into whether we could use pyo3 to just expose our Rust SDK through Python to avoid a re-write
 

  • Research: Python async and gRPC libraries
  • Write RFD describing proposed design for Python SDK
  • Implement Python SDK RFD
  • Create and test dummy plugin using Python SDK
  • Document Python SDK on website
  • Develop release process for Python SDK
@j-lanson j-lanson added type: enhancement New feature or request status: needs-rfd This topic is big enough to require an RFD. product: python-sdk Relates to the Python plugin SDK tracking-issue This issue tracks a larger task. labels Jan 14, 2025
@j-lanson j-lanson self-assigned this Feb 24, 2025
@j-lanson j-lanson moved this to In Progress in Hipcheck Product Roadmap Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: python-sdk Relates to the Python plugin SDK status: needs-rfd This topic is big enough to require an RFD. tracking-issue This issue tracks a larger task. type: enhancement New feature or request
Projects
Status: In Progress
Development

No branches or pull requests

1 participant