Skip to main content

Python Generated gRPC client and server interfaces from Digitalkin's service apis

Project description

digitalkin_proto

CI PyPI Python Version License

Python Generated gRPC client and server interfaces from Digitalkin's service APIs.

Installation

pip install digitalkin_proto

Overview

This package provides Python interfaces generated from Digitalkin's Protocol Buffer definitions, enabling seamless integration with Digitalkin services via gRPC.

Usage

Basic Import

import digitalkin_proto
from digitalkin_proto.agentic_mesh_protocol.module.v1 import module_pb2, module_service_pb2_grpc

Working with gRPC Services

Example for connecting to a gRPC service:

import grpc
from digitalkin_proto.agentic_mesh_protocol.module.v1 import module_service_pb2_grpc
from digitalkin_proto.agentic_mesh_protocol.module.v1 import module_pb2

# Create a gRPC channel and client stub
channel = grpc.insecure_channel('localhost:50051')
stub = module_service_pb2_grpc.ModuleServiceStub(channel)

# Create a request object
request = module_pb2.YourRequestType(
    field1="value1",
    field2="value2"
)

# Call the service
response = stub.YourServiceMethod(request)
print(response)

Development

Prerequisites

  • Python 3.10+
  • uv - Modern Python package management
  • Task - Task runner
  • rsync - For copying generated files

Note: buf and protoc are handled by the submodule via npx, no local installation needed

Setup Development Environment

# Clone the repository with submodules
git clone --recurse-submodules https://github.com/DigitalKin-ai/service-apis-py.git
cd service-apis-py

# Setup development environment
task setup

# Or use the quick dev setup command
task dev

Common Development Tasks

# Generate Python code from protobuf definitions
task gen

# Build the package
task build

# Run tests
task test

# Format code
task fmt

# Lint code
task lint

# Clean build artifacts
task clean

# Bump version
task bump-version -- patch
task bump-version -- minor
task bump-version -- major

Publishing Process

  1. Update code and commit changes
  2. Use the GitHub "Create Release" workflow to bump version (patch, minor, major)
  3. The workflow will automatically create a new release and publish to PyPI

License

This project is licensed under the terms specified in the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

digitalkin_proto-0.2.0.dev6.tar.gz (132.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

digitalkin_proto-0.2.0.dev6-py3-none-any.whl (206.2 kB view details)

Uploaded Python 3

File details

Details for the file digitalkin_proto-0.2.0.dev6.tar.gz.

File metadata

  • Download URL: digitalkin_proto-0.2.0.dev6.tar.gz
  • Upload date:
  • Size: 132.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for digitalkin_proto-0.2.0.dev6.tar.gz
Algorithm Hash digest
SHA256 30fcaf02aa546b53a0c5eb339672999e6368b7f2fd836e84f1568be22bd35f8f
MD5 febda1c961949358fcedfb47fad39396
BLAKE2b-256 e6499f1f39b5699f7a38375fb878e406a3d07bbd848ce303748f5f778ab732aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for digitalkin_proto-0.2.0.dev6.tar.gz:

Publisher: publish.yml on DigitalKin-ai/service-apis-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file digitalkin_proto-0.2.0.dev6-py3-none-any.whl.

File metadata

File hashes

Hashes for digitalkin_proto-0.2.0.dev6-py3-none-any.whl
Algorithm Hash digest
SHA256 7044d120a8dd6ad77f64bcb70ee671c297b928aa680e3835cd5b7619b92bb40f
MD5 7deece3256d3b8413cb317a01eff7f7c
BLAKE2b-256 8ae5a4f07e891b68c40599fecb749628865136bc53387be08b6d36f7b90fa617

See more details on using hashes here.

Provenance

The following attestation bundles were made for digitalkin_proto-0.2.0.dev6-py3-none-any.whl:

Publisher: publish.yml on DigitalKin-ai/service-apis-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page