{"id":23469894,"url":"https://github.com/vapor-ware/synse-server-grpc","last_synced_at":"2025-04-14T16:33:53.908Z","repository":{"id":29873335,"uuid":"106422519","full_name":"vapor-ware/synse-server-grpc","owner":"vapor-ware","description":"The internal gRPC API for Synse Server and its plugins","archived":false,"fork":false,"pushed_at":"2023-10-05T17:03:29.000Z","size":302,"stargazers_count":1,"open_issues_count":2,"forks_count":3,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-11-16T03:35:40.700Z","etag":null,"topics":["grpc","synse","synse-plugin","synse-server"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vapor-ware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-10-10T13:41:56.000Z","updated_at":"2024-02-06T22:30:50.000Z","dependencies_parsed_at":"2023-09-27T20:02:59.984Z","dependency_job_id":null,"html_url":"https://github.com/vapor-ware/synse-server-grpc","commit_stats":{"total_commits":60,"total_committers":4,"mean_commits":15.0,"dds":"0.050000000000000044","last_synced_commit":"9c04c13d4e5a38f95715f4da6bd5a7e2001ddfcb"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-server-grpc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-server-grpc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-server-grpc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-server-grpc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vapor-ware","download_url":"https://codeload.github.com/vapor-ware/synse-server-grpc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231118616,"owners_count":18330493,"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","synse","synse-plugin","synse-server"],"created_at":"2024-12-24T15:36:46.579Z","updated_at":"2024-12-24T15:36:54.624Z","avatar_url":"https://github.com/vapor-ware.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Synse gRPC\n\n[![PyPI](https://img.shields.io/pypi/v/synse-grpc.svg)](https://pypi.python.org/pypi/synse-grpc)\n[![Build](https://build.vio.sh/buildStatus/icon?job=vapor-ware/synse-server-grpc/master)](https://build.vio.sh/blue/organizations/jenkins/vapor-ware%2Fsynse-server-grpc/activity)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-server-grpc.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-server-grpc?ref=badge_shield)\n\nThe internal [gRPC](https://grpc.io/docs/) API for the [Synse](https://github.com/vapor-ware/synse) platform.\n\nThis API enables bi-directional communication between [Synse Server](https://github.com/vapor-ware/synse-server)\nand its registered data-providing plugins. This API is kept in its own repository\nsince it is used by multiple components written in different languages. This repo\ncontains:\n\n- The Synse gRPC spec ([synse.proto](synse.proto))\n- The auto-generated gRPC code for Go ([go/](go))\n- The auto-generated gRPC code for Python with a simple client wrapper ([python/](python))\n\n## Getting\n\n### Go\n\n```\ngo get github.com/vapor-ware/synse-server-gprc/go\n```\n\n### Python\n\n```\npip install synse_grpc\n```\n\n## Developing\n\n### Generating Language Sources\n\nIf changes need to be made to the gRPC API, it is important to ensure backwards compatibility\nwith the existing API spec. See the gRPC documentation for details on this. Additionally, the\nfiles within the `go/` directory and the `synse_pb2.py` and `synse_pb2_grpc.py` files in the\n`python/` directory are auto-generated and should **not** be modified manually. Instead, the\n[protobuf](https://developers.google.com/protocol-buffers/) spec ([synse.proto](synse.proto))\nshould be modified and new source files should be generated. Makefile targets are provided to\nmake this simple:\n\n```bash\nmake all\n```\n\nSource files for a single supported language may be built with the language-specific target,\ne.g.\n\n```bash\n# auto-generate the Python source files\nmake python\n\n# auto-generate the Go source files\nmake go\n```\n\n### Releasing\n\nA new release is triggered by GitHub tag. The version of the release is defined in\n`python/synse_grpc/__init__.py`. The version should follow the SemVer spec. Once a\ncorresponding tag is pushed (e.g. via `make github-tag`), CI will package, release,\nand publish any artifacts.\n\nReleasing and artifact publishing should not be done manually.\n\n### Troubleshooting\n\nTo see a list of available make targets and a brief description, use\n\n```bash\nmake help\n```\n\nIf there is a bug or other issue you would like to report, please open a GitHub issue and provide\nas much context around the bug/issue as possible.\n\n## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-server-grpc.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-server-grpc?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-server-grpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvapor-ware%2Fsynse-server-grpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-server-grpc/lists"}