Description:

This milestone focuses on updating and refactoring the kin-kernel package to kin_sdk with the integration of gRPC for improved service communication and the addition of workflow management capabilities. The goal is to modernize the package, making it more modular, extensible, and reliable. Key tasks include renaming the package, creating various modules (kin, trigger, tool), developing a kinWorkflow service for workflow management, and connecting it to the SurrealDB database. The milestone also includes deploying a test version, writing unit tests, updating documentation, and publishing the new version on PyPI.

Tasks:

1. Package Renaming and Refactoring:

   • Rename the kin-kernel package to kin_sdk
   • Refactor the project to use gRPC

2. Module and Service Creation:

   • Create a service registry
   • Create a kin module
   • Create a trigger module
   • Create a tool module
   • Ensure all modules inherit from a base gRPC module

3. Protobufs and Services:

   • Create protobufs for each of the three services
   • Develop the kinWorkflow service for managing workflows
   • Connect kinWorkflow to the SurrealDB database
   • Provide a functional example of a kin workflow with a trigger and multiple tools

4. Testing and Deployment:

   • Deploy a test version on Railway
   • Write unit tests

5. Documentation and Publishing:

   • Update the documentation
   • Publish the new version of the package by changing the name on PyPI

Priority: High 🚨

Business Outcome:

This milestone will enhance the modularity and extensibility of the kin_sdk package, making it easier to integrate new features and services in the future. It will also improve the performance and reliability of the services through the use of gRPC, ultimately providing a more robust and scalable solution for users.

Potential Solution:

Adopt gRPC for service communication, create a modular architecture where each service inherits from a base gRPC module, and use SurrealDB for workflow management. Ensure that functional examples and comprehensive documentation are provided to facilitate user adoption and ease of use.