{"id":19908795,"url":"https://github.com/mscheong01/krotodc","last_synced_at":"2025-05-09T00:10:10.389Z","repository":{"id":149987966,"uuid":"622059122","full_name":"mscheong01/krotoDC","owner":"mscheong01","description":"Protobuf Kotlin Dataclass, Converter \u0026 Custom Kotlin Coroutine gRPC Generator","archived":false,"fork":false,"pushed_at":"2025-04-16T07:22:14.000Z","size":53888,"stargazers_count":96,"open_issues_count":6,"forks_count":10,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-09T00:10:06.986Z","etag":null,"topics":["grpc-java","grpc-kotlin","kotlin","kotlinpoet","protobuf","protobuf-java"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mscheong01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-01T02:20:25.000Z","updated_at":"2025-04-22T04:51:44.000Z","dependencies_parsed_at":"2023-04-15T17:18:15.746Z","dependency_job_id":"1aff9c1f-a385-49ea-b797-4f38b49bb2d0","html_url":"https://github.com/mscheong01/krotoDC","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscheong01%2FkrotoDC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscheong01%2FkrotoDC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscheong01%2FkrotoDC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscheong01%2FkrotoDC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mscheong01","download_url":"https://codeload.github.com/mscheong01/krotoDC/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166521,"owners_count":21864482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grpc-java","grpc-kotlin","kotlin","kotlinpoet","protobuf","protobuf-java"],"created_at":"2024-11-12T21:13:29.622Z","updated_at":"2025-05-09T00:10:10.344Z","avatar_url":"https://github.com/mscheong01.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# krotoDC\n\nkrotoDC is a protoc plugin for generating Kotlin data classes and gRPC service/stub from a .proto input. This library makes it easy to work with Protocol Buffers and gRPC in your Kotlin projects.\n\ncheck out my [blog post](https://medium.com/@icycle0409/introducing-krotodc-use-protobuf-and-grpc-with-kotlin-dataclasses-3144d0b20032) that introduces krotoDC\n## Features\n\n- Generates Kotlin data classes from .proto files\n- Generates Converter extension methods between generated classes and GeneratedMessageV3 classes\n- Generates gRPC service/stub based on the service definition in .proto files\n- Supports Kotlin specific features like nullable fields and sealed oneof classes: \n\n  see the generated code spec [here](https://github.com/mscheong01/krotoDC/blob/main/generator/README.md)\n\n## Installation\n\nIn your project's `build.gradle.kts` file, add the following dependencies:\n\n```kotlin\ndependencies {\n    implementation(\"com.google.protobuf:protobuf-java:4.30.1\")\n    implementation(\"com.google.protobuf:protobuf-java-util:4.30.1\")\n    implementation(\"io.grpc:grpc-stub:1.70.0\")\n    implementation(\"io.grpc:grpc-kotlin-stub:1.4.0\")\n    implementation(\"io.github.mscheong01:krotoDC-core:1.2.0\")\n}\n```\n\n## Usage\n\n1. Configure the protobuf plugin in your `build.gradle.kts` file:\n\n```kotlin\nprotobuf {\n    protoc {\n        artifact = \"com.google.protobuf:protoc:4.30.1\"\n    }\n    plugins {\n        id(\"grpc\") {\n            artifact = \"io.grpc:protoc-gen-grpc-java:1.70.1\"\n        }\n        id(\"krotoDC\") {\n            artifact = \"io.github.mscheong01:protoc-gen-krotoDC:1.2.0:jdk8@jar\"\n        }\n    }\n    generateProtoTasks {\n        all().forEach {\n            it.plugins {\n                id(\"grpc\")\n                id(\"krotoDC\")\n            }\n        }\n    }\n}\n```\n\n2. Create your `.proto` files with your message and service definitions.\n\n3. Build your project, and the plugin will generate Kotlin data classes and gRPC service/stub based on the `.proto` files.\n\n## Snapshot Versions\nkrotoDC provides snapshot versions that are automatically released when changes are pushed to the main branch. \nThe current snapshot version is the next minor version of the current release version with a -SNAPSHOT suffix. \nFor example, if the current release is 1.2.3, the snapshot version will be 1.3.0-SNAPSHOT.\n\nTo use snapshot versions, add the maven snapshot repository to your build configuration\n```kotlin\nrepositories {\n    maven {\n        url = uri(\"https://s01.oss.sonatype.org/content/repositories/snapshots/\")\n    }\n}\n```\n## Contributing\n\nContributions are welcome! Please see our [contributing guidelines](https://github.com/mscheong01/krotoDC/blob/main/CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is licensed under the [Apache 2.0 License](https://github.com/mscheong01/krotoDC/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmscheong01%2Fkrotodc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmscheong01%2Fkrotodc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmscheong01%2Fkrotodc/lists"}