Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

th2 gRPC generator template library (1.4.0)

This is the template project for creating custom gRPC libraries. It contains an example of proto messages and services.
The tool generates code from .proto files and uploads built packages (.proto files and generated code) to the 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

1.4.0

  • Implement stubs creation for Python

Metadata

Release files for th2-grpc-generator-template 1.4.0.dev3902419110

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for th2-grpc-generator-template 1.4.0.dev3902419110
File Size Uploaded
th2_grpc_generator_template-1.4.0.dev3902419110.tar.gz 8.0 kB Details

Release files / th2_grpc_generator_template-1.4.0.dev3902419110.tar.gz

Download URL th2_grpc_generator_template-1.4.0.dev3902419110.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3158a8e73caae9c45bd81075fc5d1a3b29e4faf9e6f74779bf6ddb834306e128
BLAKE2b-256 checksum
How to use checksums
14b485b8674037917f121e9885c2dc1f5e5f4fa33cbc8a28a05e239be7f2b9f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page