# th2 gRPC check1 library (4.1.0)
This library contains proto messages and `Check1` service with RPC methods that are used in [th2 check1](https://github.com/th2-net/th2-check1 "th2-check1"). See [check1.proto](src/main/proto/th2_grpc_check1/check1.proto "check1.proto") file for details. <br>
Tool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to the specified repositories.
## 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.
### 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.1.0
+ merged `3.8.0`
### 4.0.0
+ Migrated to `grpc-common` version with books/pages
+ Marked deprecated fields as `reserved`
+ Added `book_name` to `CheckRuleRequest`, `CheckSequenceRuleRequest` and `NoMessageCheckRequest`
### 3.8.0
+ Update `th2-bom` to `4.2.0`
+ Update `grpc-service-generator` to `3.3.1`
+ Updated grpc to `1.48.1`
+ Updated protobuf to `3.21.7`
+ Add Python vulnerabilities scan
### 3.7.0
+ Update `th2-bom` to `4.1.0`
### 3.6.0
+ Update to `th2-grpc-common` version `3.11.1`
### 3.5.1
#### Changed:
+ `grpc-common` version is updated to 3.9.0
### 3.5.0
#### Added:
+ `silence_check` parameter for `CheckSequenceRule`. Enables automated check for extra messages that match the pre-filter.
#### Changed:
+ Migrated `grpc-common` version from `3.7.0` to `3.8.0`
+ Added `time_precision` and `decimal_precision` to `RootComparisonSettings` message
+ Added `EQ_TIME_PRECISION` and `EQ_DECIMAL_PRECISION` filter operations
### 3.4.2
+ Migrated `grpc-common` version from `3.6.0` to `3.7.0`
+ Added `check_repeating_group_order` parameter to `RootComparisonSettings` message
### 3.4.1
+ Migrated `grpc-common` version from `3.4.0` to `3.6.0`
+ Added the new parameters `description` to `RootMessageFilter` message
### 3.4.0
+ Update to `th2-grpc-common` version `3.4.0`
### 3.3.0
+ Implemented NoMessageCheck rule task. Updated CheckSequence rule task
### 3.2.0
+ Implement stubs creation for Python
Raw data
{
"_id": null,
"home_page": "https://github.com/th2-net/th2-grpc-check1",
"name": "th2-grpc-check1",
"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/43/38/70908745bba444f5a2f7f11089491c2a4d552ae8c06a7c03ece513658ab7/th2_grpc_check1-4.1.1.tar.gz",
"platform": null,
"description": "# th2 gRPC check1 library (4.1.0)\n\nThis library contains proto messages and `Check1` service with RPC methods that are used in [th2 check1](https://github.com/th2-net/th2-check1 \"th2-check1\"). See [check1.proto](src/main/proto/th2_grpc_check1/check1.proto \"check1.proto\") file for details. <br>\nTool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to the specified repositories.\n\n## How to maintain a project\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### Java\nIf you wish to manually create and publish a package for Java, run the following command:\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n -Purl=${URL} \\ \n -Puser=${USER} \\\n -Ppassword=${PASSWORD}\n```\n`URL`, `USER` and `PASSWORD` are parameters for publishing.\n\n### Python\nIf you wish to manually create and publish a package for Python:\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.1.0\n+ merged `3.8.0`\n\n### 4.0.0\n+ Migrated to `grpc-common` version with books/pages\n+ Marked deprecated fields as `reserved`\n+ Added `book_name` to `CheckRuleRequest`, `CheckSequenceRuleRequest` and `NoMessageCheckRequest`\n\n### 3.8.0\n\n+ Update `th2-bom` to `4.2.0` \n+ Update `grpc-service-generator` to `3.3.1` \n+ Updated grpc to `1.48.1`\n+ Updated protobuf to `3.21.7`\n+ Add Python vulnerabilities scan\n\n### 3.7.0\n\n+ Update `th2-bom` to `4.1.0`\n\n### 3.6.0\n\n+ Update to `th2-grpc-common` version `3.11.1`\n\n### 3.5.1\n\n#### Changed:\n\n+ `grpc-common` version is updated to 3.9.0\n\n### 3.5.0\n\n#### Added:\n+ `silence_check` parameter for `CheckSequenceRule`. Enables automated check for extra messages that match the pre-filter.\n\n#### Changed:\n+ Migrated `grpc-common` version from `3.7.0` to `3.8.0`\n + Added `time_precision` and `decimal_precision` to `RootComparisonSettings` message\n + Added `EQ_TIME_PRECISION` and `EQ_DECIMAL_PRECISION` filter operations\n\n### 3.4.2\n+ Migrated `grpc-common` version from `3.6.0` to `3.7.0`\n + Added `check_repeating_group_order` parameter to `RootComparisonSettings` message\n\n### 3.4.1\n+ Migrated `grpc-common` version from `3.4.0` to `3.6.0`\n + Added the new parameters `description` to `RootMessageFilter` message\n\n### 3.4.0\n\n+ Update to `th2-grpc-common` version `3.4.0`\n\n### 3.3.0\n+ Implemented NoMessageCheck rule task. Updated CheckSequence rule task\n\n### 3.2.0\n\n+ Implement stubs creation for Python",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "th2_grpc_check1",
"version": "4.1.1",
"project_urls": {
"Homepage": "https://github.com/th2-net/th2-grpc-check1"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "433870908745bba444f5a2f7f11089491c2a4d552ae8c06a7c03ece513658ab7",
"md5": "39b7d0a346c0ada6064de3288dc52e00",
"sha256": "46051aa970c2d1c06b789718642d7595039808b73306347078023d4a7016b7a8"
},
"downloads": -1,
"filename": "th2_grpc_check1-4.1.1.tar.gz",
"has_sig": false,
"md5_digest": "39b7d0a346c0ada6064de3288dc52e00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10213,
"upload_time": "2023-07-20T12:13:44",
"upload_time_iso_8601": "2023-07-20T12:13:44.380777Z",
"url": "https://files.pythonhosted.org/packages/43/38/70908745bba444f5a2f7f11089491c2a4d552ae8c06a7c03ece513658ab7/th2_grpc_check1-4.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 12:13:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "th2-net",
"github_project": "th2-grpc-check1",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "th2-grpc-check1"
}