# th2 gRPC act template library (4.2.0)
This is the template project for creating custom gRPC act libraries. It contains proto messages and `Act` service that
are used [th2 act template](https://github.com/th2-net/th2-act-template-j "th2-act-template-j").
See [act_template.proto](src/main/proto/th2_grpc_act_template/act_template.proto "act_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 transform the template
1. Create a directory with the same name as the project name (use underscores instead of dashes) under `src/main/proto`
directory (remove other files and directories if they exist).
2. Place your custom `.proto` files in the created directory. Pay attention to both the `package` specifier and to
the `import` statements.
3. Edit `release_version` and `vcs_url` properties in `gradle.properties` file.
4. Edit `rootProject.name` variable in `settings.gradle` file. This will be the name of the Java package.
5. Edit `package_info.json` file in order to specify its name and its version for Python package (create the file in
case it's absent).
6. Edit parameters of `setup.py` in `setup` function invocation such as: `author`, `author_email`, `url`. Do not edit
the other's parameters.
7. Edit `README.md` file according to the new project.
Note that the name of the created directory under `src/main/proto` directory is used in Python (it's a package name).
## How to maintain a project
1. Perform the necessary changes.
2. Update the package version of Java in `gradle.properties` file.
3. Update the package version of Python in `package_info.json` file.
4. Commit everything.
## How to run project
### Java
If you wish to manually create and publish a package for Java, run the following command:
```
gradle --no-daemon clean build publish artifactoryPublish \
-Purl=${URL} \
-Puser=${USER} \
-Ppassword=${PASSWORD}
```
`URL`, `USER` and `PASSWORD` are parameters for publishing.
### Python
If you wish to manually create and publish a package for Python:
1. Generate services with `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 using `twine`:
```
pip install -r requirements.txt
pip install twine
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
### 4.2.0
+ Added rpc to send messages directly to component avoiding codec.
### 4.1.0
+ Update to `th2-grpc-common` version `4.3.0`
+ Update to `th2-bom` version `4.4.0`
+ Update to `th2-grpc-service-genrator` version `3.4.0`
### 4.0.0
+ Update to `th2-grpc-common` version `4.0.0`
+ Marked deprecated fields as `reserved`
### 3.12.0
+ grpc version bump to `1.48.2`
+ protobuf version bump to `3.21.7`
+ serviceGenerator version bump to `3.3.1`
+ Add dependency check pipeline step.
+ Add dev-release workflow.
### 3.11.0
+ Add `multiSendMessage` method for sending several messages at once
### 3.10.0
+ Add `placeOrderCancelReplaceRequest` method for sending `OrderCancelReplaceRequest`
+ Rename `placeCancelFIX` to `placeOrderCancelRequest`
### 3.9.0
+ Update to `th2-grpc-common` version `3.11.1`
### 3.8.0
+ Update to `th2-grpc-common` version `3.9.0`
### 3.7.0
+ Add new method for sending `SecurityStatusRequest`
### 3.6.0
+ Add new method for sending `OrderCancelRequest`
### 3.5.0
+ Update to `th2-grpc-common` version `3.8.0`
### 3.4.0
+ Update to `th2-grpc-common` version `3.7.0`
### 3.3.0
+ Update to `th2-grpc-common` version `3.4.0`
### 3.2.0
+ Implement stubs creation for Python
Raw data
{
"_id": null,
"home_page": "https://github.com/th2-net/th2-grpc-act-template",
"name": "th2-grpc-act-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/9b/d8/34c46444e19dca682ea10d6595e75ff1f08a8ab8829229738392a3dc86e7/th2_grpc_act_template-4.2.0.tar.gz",
"platform": null,
"description": "# th2 gRPC act template library (4.2.0)\n\nThis is the template project for creating custom gRPC act libraries. It contains proto messages and `Act` service that\nare used [th2 act template](https://github.com/th2-net/th2-act-template-j \"th2-act-template-j\").\nSee [act_template.proto](src/main/proto/th2_grpc_act_template/act_template.proto \"act_template.proto\") file for\ndetails. <br>\nTool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to specified\nrepositories.\n\n## How to transform the template\n\n1. Create a directory with the same name as the project name (use underscores instead of dashes) under `src/main/proto`\n directory (remove other files and directories if they exist).\n2. Place your custom `.proto` files in the created directory. Pay attention to both the `package` specifier and to\n the `import` statements.\n3. Edit `release_version` and `vcs_url` properties in `gradle.properties` file.\n4. Edit `rootProject.name` variable in `settings.gradle` file. This will be the name of the Java package.\n5. Edit `package_info.json` file in order to specify its name and its version for Python package (create the file in\n case it's absent).\n6. Edit parameters of `setup.py` in `setup` function invocation such as: `author`, `author_email`, `url`. Do not edit\n the other's parameters.\n7. Edit `README.md` file according to the new project.\n\nNote that the name of the created directory under `src/main/proto` directory is used in Python (it's a package name).\n\n## How to maintain a project\n\n1. Perform the necessary changes.\n2. Update the package version of Java in `gradle.properties` file.\n3. Update the package version of Python in `package_info.json` file.\n4. Commit everything.\n\n## How to run project\n\n### Java\n\nIf you wish to manually create and publish a package for Java, run the following command:\n\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n -Purl=${URL} \\ \n -Puser=${USER} \\\n -Ppassword=${PASSWORD}\n```\n\n`URL`, `USER` and `PASSWORD` are parameters for publishing.\n\n### Python\n\nIf you wish to manually create and publish a package for Python:\n\n1. Generate services with `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 using `twine`:\n ```\n pip install -r requirements.txt\n pip install twine\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### 4.2.0\n+ Added rpc to send messages directly to component avoiding codec.\n\n### 4.1.0\n\n+ Update to `th2-grpc-common` version `4.3.0`\n+ Update to `th2-bom` version `4.4.0`\n+ Update to `th2-grpc-service-genrator` version `3.4.0`\n\n### 4.0.0\n\n+ Update to `th2-grpc-common` version `4.0.0`\n+ Marked deprecated fields as `reserved`\n\n### 3.12.0\n\n+ grpc version bump to `1.48.2`\n+ protobuf version bump to `3.21.7`\n+ serviceGenerator version bump to `3.3.1`\n+ Add dependency check pipeline step.\n+ Add dev-release workflow.\n\n### 3.11.0\n\n+ Add `multiSendMessage` method for sending several messages at once\n\n### 3.10.0\n\n+ Add `placeOrderCancelReplaceRequest` method for sending `OrderCancelReplaceRequest`\n+ Rename `placeCancelFIX` to `placeOrderCancelRequest`\n\n### 3.9.0\n\n+ Update to `th2-grpc-common` version `3.11.1`\n\n### 3.8.0\n\n+ Update to `th2-grpc-common` version `3.9.0`\n\n### 3.7.0\n\n+ Add new method for sending `SecurityStatusRequest`\n\n### 3.6.0\n\n+ Add new method for sending `OrderCancelRequest`\n\n### 3.5.0\n\n+ Update to `th2-grpc-common` version `3.8.0`\n\n### 3.4.0\n\n+ Update to `th2-grpc-common` version `3.7.0`\n\n### 3.3.0\n\n+ Update to `th2-grpc-common` version `3.4.0`\n\n### 3.2.0\n\n+ Implement stubs creation for Python",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "th2_grpc_act_template",
"version": "4.2.0",
"project_urls": {
"Homepage": "https://github.com/th2-net/th2-grpc-act-template"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bd834c46444e19dca682ea10d6595e75ff1f08a8ab8829229738392a3dc86e7",
"md5": "a54272fd6ceabbb0e9fa3a9e54322dab",
"sha256": "fa67a398a55f1738f3cc41c1a38cea3408e80cee38ba9902ca0ff007b34a011e"
},
"downloads": -1,
"filename": "th2_grpc_act_template-4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a54272fd6ceabbb0e9fa3a9e54322dab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9898,
"upload_time": "2023-09-19T11:36:22",
"upload_time_iso_8601": "2023-09-19T11:36:22.979302Z",
"url": "https://files.pythonhosted.org/packages/9b/d8/34c46444e19dca682ea10d6595e75ff1f08a8ab8829229738392a3dc86e7/th2_grpc_act_template-4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-19 11:36:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "th2-net",
"github_project": "th2-grpc-act-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "th2-grpc-act-template"
}
JSON
