th2\u grpc_生成器_模板
th2-grpc-generator-template的Python项目详细描述
th2 gRPC生成器模板库
这是用于创建自定义gRPC库的模板项目。它包含示例原型消息和服务。
该工具从.proto
文件生成代码,并将生成的包(.proto
文件和生成的代码)上载到指定的存储库。在
如何转换模板
- 在
src/main/proto
目录下创建一个与项目名称同名的目录(使用下划线而不是破折号)(如果存在其他文件和目录,请删除它们)。在 - 将您的自定义
.proto
文件放入创建的目录中。注意package
说明符和import
语句。在 - 在
gradle.properties
文件中编辑release_version
和vcs_url
属性。在 - 编辑
rootProject.name
文件中的rootProject.name
变量。这将是Java包的名称。在 - 编辑
package_info.json
文件,以便为Python包指定名称和版本(如果没有,请创建文件)。在 - 编辑
setup
函数调用中setup.py
的参数,例如:author
,author_email
,url
。不要编辑其他的。在 - 根据新项目编辑
README.md
文件。在
注意,src/main/proto
目录下创建的目录的名称在Python中使用(它是一个包名)。在
如何维护项目
- 做出你的改变。在
gradle.properties
文件中Java包的更新版本。在package_info.json
文件中Python包的更新版本。在- 承诺一切。在
如何运行项目
Java
如果要手动创建和发布Java包,请运行以下命令:
gradle --no-daemon clean build publish artifactoryPublish \
-Pbintray_user=${BINTRAY_USER} \
-Pbintray_key=${BINTRAY_KEY}
BINTRAY_USER
和{
Python
如果要手动创建并发布Python包:
- 从
.proto
文件生成服务:- 使用Gradle下载并生成th2 Python service generator项目: ^{pr2}$ 在
- 运行th2 Python服务生成器:
在java -jar {path_to_jar} -p src/main/proto/{package_name} -w PythonServiceWriter -o src/gen/main/python/{package_name}
- 从
.proto
文件生成代码并发布所有内容: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
和{}是发布的参数。在
- 项目
标签: