th2-grpc-data-provider


Nameth2-grpc-data-provider JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/th2-net/th2-data-provider
Summaryth2_grpc_data_provider
upload_time2021-07-21 10:36:41
maintainer
docs_urlNone
authorArtem Lezgyan
requires_python>=3.7
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # th2 gRPC generator template library

This is the template project for creating custom gRPC libraries. It contains example proto messages and services. <br>
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.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/th2-net/th2-data-provider",
    "name": "th2-grpc-data-provider",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Artem Lezgyan",
    "author_email": "artem.lezgyan@exactprosystems.com",
    "download_url": "https://files.pythonhosted.org/packages/ab/47/decaf0c58c59a2166f71c71e35776f1633aac90aa83f67f23092c955147b/th2_grpc_data_provider-0.1.4.tar.gz",
    "platform": "",
    "description": "# th2 gRPC generator template library\n\nThis is the template project for creating custom gRPC libraries. It contains example proto messages and services. <br>\nTool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to specified repositories.\n\n## How to transform template\n1. 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).\n2. Place your custom `.proto` files in created directory. Pay attention to `package` specifier and `import` statements.\n3. Edit `release_version` and `vcs_url` properties in `gradle.properties` file.\n4. Edit `rootProject.name` variable in `settings.gradle` file. This will be the name of Java package.\n5. Edit `package_info.json` file in order to specify name and version for Python package (create file if it's absent).\n6. Edit parameters of `setup.py` in `setup` function invocation such as: `author`, `author_email`, `url`. Do not edit the others.\n7. Edit `README.md` file according to the new project.\n\nNote that the name of created directory under `src/main/proto` directory is used in Python (it's a package name).\n\n## How to maintain project\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\nIf you wish to manually create and publish package for Java, run these command:\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n       -Pbintray_user=${BINTRAY_USER} \\\n       -Pbintray_key=${BINTRAY_KEY}\n```\n`BINTRAY_USER` and `BINTRAY_KEY` are parameters for publishing.\n\n### Python\nIf you wish to manually create and publish package for Python:\n1. Generate services by 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:\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_data_provider",
    "version": "0.1.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b4c82dfa41844a5117058624e6a68d66",
                "sha256": "8eb0805b98a980f53a569d07ce80e14c551d795b77c76bc20fc5c07fcb6c8595"
            },
            "downloads": -1,
            "filename": "th2_grpc_data_provider-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "b4c82dfa41844a5117058624e6a68d66",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 15264,
            "upload_time": "2021-07-21T10:36:41",
            "upload_time_iso_8601": "2021-07-21T10:36:41.894789Z",
            "url": "https://files.pythonhosted.org/packages/ab/47/decaf0c58c59a2166f71c71e35776f1633aac90aa83f67f23092c955147b/th2_grpc_data_provider-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-07-21 10:36:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "th2-net",
    "github_project": "th2-data-provider",
    "lcname": "th2-grpc-data-provider"
}
        
Elapsed time: 0.30413s