# th2 Woodpecker gRPC library (0.3.0)
This library contains proto messages and `Woodpecker` service with RPC methods that are used in [th2 Woodpecker](https://github.com/th2-net/th2-woodpecker "th2-woodpecker").
See [woodpecker.proto](src/main/proto/th2_grpc_woodpecker/woodpecker.proto "woodpecker.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 from `.proto` files:
- Download and build [th2 Python service generator](https://github.com/th2-net/th2-python-service-generator "th2-python-service-generator") project with Gradle:
```
gradle clean build
```
- Run th2 Python service generator:
```
java -jar {path_to_jar} -p src/main/proto/{package_name} -w PythonServiceWriter -o src/gen/main/python/{package_name}
```
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/th2-net/th2-grpc-woodpecker",
"name": "th2-grpc-woodpecker",
"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/33/d0/8ab3fc73a59456df99f048483a7b2c7ecef33b359cc241cd4d08e6977bdc/th2_grpc_woodpecker-0.3.0.tar.gz",
"platform": null,
"description": "# th2 Woodpecker gRPC library (0.3.0)\n\nThis library contains proto messages and `Woodpecker` service with RPC methods that are used in [th2 Woodpecker](https://github.com/th2-net/th2-woodpecker \"th2-woodpecker\").\nSee [woodpecker.proto](src/main/proto/th2_grpc_woodpecker/woodpecker.proto \"woodpecker.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\n\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\n\nIf you wish to manually create and publish package for Java, run these command:\n\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n -Pbintray_user=${BINTRAY_USER} \\\n -Pbintray_key=${BINTRAY_KEY}\n```\n\n`BINTRAY_USER` and `BINTRAY_KEY` are parameters for publishing.\n\n### Python\n\nIf you wish to manually create and publish package for Python:\n\n1. Generate services from `.proto` files:\n - Download and build [th2 Python service generator](https://github.com/th2-net/th2-python-service-generator \"th2-python-service-generator\") project with Gradle:\n ```\n gradle clean build\n ```\n - Run th2 Python service generator:\n ```\n java -jar {path_to_jar} -p src/main/proto/{package_name} -w PythonServiceWriter -o src/gen/main/python/{package_name}\n ```\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.",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "th2_grpc_woodpecker",
"version": "0.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33d08ab3fc73a59456df99f048483a7b2c7ecef33b359cc241cd4d08e6977bdc",
"md5": "7a5524efa5bdbfd1dfc573ee43b9a5e6",
"sha256": "6840a753fcaf78a6d02d8700812518c19fced11f705d37a924f55d9caffffa12"
},
"downloads": -1,
"filename": "th2_grpc_woodpecker-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "7a5524efa5bdbfd1dfc573ee43b9a5e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7460,
"upload_time": "2022-12-14T12:13:00",
"upload_time_iso_8601": "2022-12-14T12:13:00.535692Z",
"url": "https://files.pythonhosted.org/packages/33/d0/8ab3fc73a59456df99f048483a7b2c7ecef33b359cc241cd4d08e6977bdc/th2_grpc_woodpecker-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 12:13:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "th2-net",
"github_project": "th2-grpc-woodpecker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "th2-grpc-common",
"specs": [
[
">=",
"3"
],
[
"<",
"4"
]
]
},
{
"name": "mypy-protobuf",
"specs": [
[
"==",
"3.2"
]
]
}
],
"lcname": "th2-grpc-woodpecker"
}
JSON
