th2-grpc-generator-template 1.3.1.dev582353020

th2_grpc_generator_template

th2 gRPC generator template library

This is the template project for creating custom gRPC libraries. It contains example proto messages and services.
Tool generates code from .proto files and uploads built packages (.proto files and generated code) to specified repositories.

How to transform template

1. Create a directory with the same name as 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 created directory. Pay attention to package specifier and 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 Java package.
5. Edit package_info.json file in order to specify name and version for Python package (create file if it's absent).
6. Edit parameters of setup.py in setup function invocation such as: author, author_email, url. Do not edit the others.
7. Edit README.md file according to the new project.

Note that the name of created directory under src/main/proto directory is used in Python (it's a package name).

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.