digitalkin-proto


Namedigitalkin-proto JSON
Version 0.1.16 PyPI version JSON
download
home_pageNone
SummaryPython Generated gRPC client and server interfaces from Digitalkin's service apis
upload_time2025-07-15 10:10:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords digitalkin kin agent gprc sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # digitalkin_proto

[![CI](https://github.com/DigitalKin-ai/service-apis-py/actions/workflows/ci.yml/badge.svg)](https://github.com/DigitalKin-ai/service-apis-py/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/digitalkin_proto.svg)](https://pypi.org/project/digitalkin_proto/)
[![Python Version](https://img.shields.io/pypi/pyversions/digitalkin_proto.svg)](https://pypi.org/project/digitalkin_proto/)
[![License](https://img.shields.io/github/license/DigitalKin-ai/service-apis-py)](https://github.com/DigitalKin-ai/service-apis-py/blob/main/LICENSE)

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

## Installation

```bash
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

```python
import digitalkin_proto
from digitalkin_proto.digitalkin.module.v1 import module_pb2, module_service_pb2_grpc
```

### Working with gRPC Services

Example for connecting to a gRPC service:

```python
import grpc
from digitalkin_proto.digitalkin.module.v1 import module_service_pb2_grpc
from digitalkin_proto.digitalkin.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](https://astral.sh/uv) - Modern Python package management
- [buf](https://buf.build/docs/installation) - Protocol buffer toolkit
- [protoc](https://grpc.io/docs/protoc-installation/) - Protocol Buffers
  compiler
- [Task](https://taskfile.dev/) - Task runner

### Setup Development Environment

```bash
# 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 and activate the venv
task setup-dev
source .venv/bin/activate

```

### Common Development Tasks

```bash
# Generate Python code from protobuf definitions
task gen-proto

# Build the package
task build-package

# Run tests
task run-tests

# Format code
task format

# Lint code
task lint

# Clean build artifacts
task clean

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

### 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "digitalkin-proto",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "digitalkin, kin, agent, gprc, sdk",
    "author": null,
    "author_email": "\"DigitalKin.ai\" <contact@digitalkin.ai>",
    "download_url": "https://files.pythonhosted.org/packages/92/4e/2da204dc204825676622c28f34d105b83882500ca7e393a6f52bf09eef5d/digitalkin_proto-0.1.16.tar.gz",
    "platform": null,
    "description": "# digitalkin_proto\n\n[![CI](https://github.com/DigitalKin-ai/service-apis-py/actions/workflows/ci.yml/badge.svg)](https://github.com/DigitalKin-ai/service-apis-py/actions/workflows/ci.yml)\n[![PyPI](https://img.shields.io/pypi/v/digitalkin_proto.svg)](https://pypi.org/project/digitalkin_proto/)\n[![Python Version](https://img.shields.io/pypi/pyversions/digitalkin_proto.svg)](https://pypi.org/project/digitalkin_proto/)\n[![License](https://img.shields.io/github/license/DigitalKin-ai/service-apis-py)](https://github.com/DigitalKin-ai/service-apis-py/blob/main/LICENSE)\n\nPython Generated gRPC client and server interfaces from Digitalkin's service\nAPIs.\n\n## Installation\n\n```bash\npip install digitalkin_proto\n```\n\n## Overview\n\nThis package provides Python interfaces generated from Digitalkin's Protocol\nBuffer definitions, enabling seamless integration with Digitalkin services via\ngRPC.\n\n## Usage\n\n### Basic Import\n\n```python\nimport digitalkin_proto\nfrom digitalkin_proto.digitalkin.module.v1 import module_pb2, module_service_pb2_grpc\n```\n\n### Working with gRPC Services\n\nExample for connecting to a gRPC service:\n\n```python\nimport grpc\nfrom digitalkin_proto.digitalkin.module.v1 import module_service_pb2_grpc\nfrom digitalkin_proto.digitalkin.module.v1 import module_pb2\n\n# Create a gRPC channel and client stub\nchannel = grpc.insecure_channel('localhost:50051')\nstub = module_service_pb2_grpc.ModuleServiceStub(channel)\n\n# Create a request object\nrequest = module_pb2.YourRequestType(\n    field1=\"value1\",\n    field2=\"value2\"\n)\n\n# Call the service\nresponse = stub.YourServiceMethod(request)\nprint(response)\n```\n\n## Development\n\n### Prerequisites\n\n- Python 3.10+\n- [uv](https://astral.sh/uv) - Modern Python package management\n- [buf](https://buf.build/docs/installation) - Protocol buffer toolkit\n- [protoc](https://grpc.io/docs/protoc-installation/) - Protocol Buffers\n  compiler\n- [Task](https://taskfile.dev/) - Task runner\n\n### Setup Development Environment\n\n```bash\n# Clone the repository with submodules\ngit clone --recurse-submodules https://github.com/DigitalKin-ai/service-apis-py.git\ncd service-apis-py\n\n# Setup development environment and activate the venv\ntask setup-dev\nsource .venv/bin/activate\n\n```\n\n### Common Development Tasks\n\n```bash\n# Generate Python code from protobuf definitions\ntask gen-proto\n\n# Build the package\ntask build-package\n\n# Run tests\ntask run-tests\n\n# Format code\ntask format\n\n# Lint code\ntask lint\n\n# Clean build artifacts\ntask clean\n\n# Bump version\ntask bump-version -- major\ntask bump-version -- minor\ntask bump-version -- patch\n```\n\n### Publishing Process\n\n1. Update code and commit changes\n2. Use the GitHub \"Create Release\" workflow to bump version (patch, minor,\n   major)\n3. The workflow will automatically create a new release and publish to PyPI\n\n## License\n\nThis project is licensed under the terms specified in the LICENSE file.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python Generated gRPC client and server interfaces from Digitalkin's service apis",
    "version": "0.1.16",
    "project_urls": {
        "Bug Tracker": "https://github.com/DigitalKin-ai/service-apis-py/issues",
        "Documentation": "https://github.com/DigitalKin-ai/service-apis-py/blob/main/README.md",
        "Homepage": "https://github.com/DigitalKin-ai/service-apis-py"
    },
    "split_keywords": [
        "digitalkin",
        " kin",
        " agent",
        " gprc",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6c23d7b430f3931618909962f1c048bad4034286043a85d6e13b469fb9a0ae9b",
                "md5": "2c4c3889b6de92d22768c2db8b91560e",
                "sha256": "6ac970b06406c3262d64dbd383491d054e8d4e5da0a412b11a45ff45ab7d5e2c"
            },
            "downloads": -1,
            "filename": "digitalkin_proto-0.1.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2c4c3889b6de92d22768c2db8b91560e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 150080,
            "upload_time": "2025-07-15T10:10:35",
            "upload_time_iso_8601": "2025-07-15T10:10:35.740653Z",
            "url": "https://files.pythonhosted.org/packages/6c/23/d7b430f3931618909962f1c048bad4034286043a85d6e13b469fb9a0ae9b/digitalkin_proto-0.1.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "924e2da204dc204825676622c28f34d105b83882500ca7e393a6f52bf09eef5d",
                "md5": "6d317c8dc3fbe171d7b29a83f2d4e8b0",
                "sha256": "ba1a3119762bd9bb9cda385af9d55c1cdfd0eff8b6e2192fb1eae4ac3609b67f"
            },
            "downloads": -1,
            "filename": "digitalkin_proto-0.1.16.tar.gz",
            "has_sig": false,
            "md5_digest": "6d317c8dc3fbe171d7b29a83f2d4e8b0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 84371,
            "upload_time": "2025-07-15T10:10:37",
            "upload_time_iso_8601": "2025-07-15T10:10:37.002450Z",
            "url": "https://files.pythonhosted.org/packages/92/4e/2da204dc204825676622c28f34d105b83882500ca7e393a6f52bf09eef5d/digitalkin_proto-0.1.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-15 10:10:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DigitalKin-ai",
    "github_project": "service-apis-py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "digitalkin-proto"
}
        
Elapsed time: 0.94041s