# th2 gRPC sim template library
This library contains proto messages and `SimTemplate` service with RPC methods that are used in [th2 sim template](https://github.com/th2-net/th2-sim-template "th2-sim-template"). See [sim_template.proto](src/main/proto/th2_grpc_sim_template/sim_template.proto "sim_template.proto") file for details. <br>
Tool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to specified repositories.
## How to maintain project
1. Make your changes.
2. Up version of Java package in `gradle.properties` file.
3. Up version of Python package in `package_info.json` file.
4. Commit everything.
## How to run project
### Java
If you wish to manually create and publish package for Java, run these command:
```
gradle --no-daemon clean build publish artifactoryPublish \
-Pbintray_user=${BINTRAY_USER} \
-Pbintray_key=${BINTRAY_KEY}
```
`BINTRAY_USER` and `BINTRAY_KEY` are parameters for publishing.
### Python
If you wish to manually create and publish package for Python:
1. Generate services by gradle:
```
gradle --no-daemon clean generateProto
```
You can find the generated files by following path: `src/gen/main/services/python`
2. Generate code from `.proto` files and publish everything:
```
pip install -r requirements.txt
python setup.py generate
python setup.py sdist
twine upload --repository-url ${PYPI_REPOSITORY_URL} --username ${PYPI_USER} --password ${PYPI_PASSWORD} dist/*
```
`PYPI_REPOSITORY_URL`, `PYPI_USER` and `PYPI_PASSWORD` are parameters for publishing.
## Release notes
### 3.3.0
+ Added `createDemoRuleCancelReplace` rpc method
### 3.2.0
+ Update to `th2-bom` version `4.5.0`
+ Update to `grpc-sim` version `5.1.0`
+ Update to `grpc-common` version `4.3.0`
+ Update to `th2-grpc-service-genrator` version `3.4.0`
+ Update to `grpcio-tools` version `1.56.0`
### 3.1.2
+ Update libraries versions.
Raw data
{
"_id": null,
"home_page": "https://github.com/th2-net/th2-grpc-sim-template",
"name": "th2-grpc-sim-template",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "TH2-devs",
"author_email": "th2-devs@exactprosystems.com",
"download_url": "https://files.pythonhosted.org/packages/4d/0c/1f6383667a0d814f560149b0bb32a441a70180ff239a14e22f837ec799c7/th2_grpc_sim_template-3.3.0.tar.gz",
"platform": null,
"description": "# th2 gRPC sim template library\n\nThis library contains proto messages and `SimTemplate` service with RPC methods that are used in [th2 sim template](https://github.com/th2-net/th2-sim-template \"th2-sim-template\"). See [sim_template.proto](src/main/proto/th2_grpc_sim_template/sim_template.proto \"sim_template.proto\") file for details. <br>\nTool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to specified repositories.\n\n## How to maintain project\n1. Make your changes.\n2. Up version of Java package in `gradle.properties` file.\n3. Up version of Python package in `package_info.json` file.\n4. Commit everything.\n\n## How to run project\n\n### Java\nIf you wish to manually create and publish package for Java, run these command:\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n -Pbintray_user=${BINTRAY_USER} \\\n -Pbintray_key=${BINTRAY_KEY}\n```\n`BINTRAY_USER` and `BINTRAY_KEY` are parameters for publishing.\n\n### Python\nIf you wish to manually create and publish package for Python:\n1. Generate services by gradle:\n ```\n gradle --no-daemon clean generateProto\n ```\n You can find the generated files by following path: `src/gen/main/services/python`\n2. Generate code from `.proto` files and publish everything:\n ```\n pip install -r requirements.txt\n python setup.py generate\n python setup.py sdist\n twine upload --repository-url ${PYPI_REPOSITORY_URL} --username ${PYPI_USER} --password ${PYPI_PASSWORD} dist/*\n ```\n `PYPI_REPOSITORY_URL`, `PYPI_USER` and `PYPI_PASSWORD` are parameters for publishing.\n\n## Release notes\n\n### 3.3.0\n\n+ Added `createDemoRuleCancelReplace` rpc method\n\n### 3.2.0\n\n+ Update to `th2-bom` version `4.5.0`\n+ Update to `grpc-sim` version `5.1.0`\n+ Update to `grpc-common` version `4.3.0`\n+ Update to `th2-grpc-service-genrator` version `3.4.0`\n+ Update to `grpcio-tools` version `1.56.0`\n\n### 3.1.2\n\n+ Update libraries versions.",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "th2_grpc_sim_template",
"version": "3.3.0",
"project_urls": {
"Homepage": "https://github.com/th2-net/th2-grpc-sim-template"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d0c1f6383667a0d814f560149b0bb32a441a70180ff239a14e22f837ec799c7",
"md5": "8a7aafa2efb3880583a6e2511def7222",
"sha256": "ee0a4465c9e34d99558a3ecb65f93d2ddb9b87ea4a4af989179241e4c4bce42b"
},
"downloads": -1,
"filename": "th2_grpc_sim_template-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8a7aafa2efb3880583a6e2511def7222",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6303,
"upload_time": "2023-10-12T12:17:09",
"upload_time_iso_8601": "2023-10-12T12:17:09.112180Z",
"url": "https://files.pythonhosted.org/packages/4d/0c/1f6383667a0d814f560149b0bb32a441a70180ff239a14e22f837ec799c7/th2_grpc_sim_template-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 12:17:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "th2-net",
"github_project": "th2-grpc-sim-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "th2-grpc-sim",
"specs": [
[
"~=",
"5.1.0rc1"
]
]
},
{
"name": "th2-grpc-common",
"specs": [
[
"~=",
"4.3.0.dev0"
]
]
}
],
"lcname": "th2-grpc-sim-template"
}
JSON
