th2-grpc-conn


Nameth2-grpc-conn JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/th2-net/th2-grpc-conn
Summaryth2_grpc_conn
upload_time2021-07-08 11:56:48
maintainer
docs_urlNone
authorTH2-devs
requires_python>=3.7
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements th2-grpc-common
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # th2 conn gRPC library (0.0.1)

This library contains proto messages and `conn` service with RPC methods which can be used in implementation of th2 conn. See [conn.proto](src/main/proto/th2_grpc_conn/conn.proto "conn.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 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 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-conn",
    "name": "th2-grpc-conn",
    "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/88/f0/c39641fda21e8233a9aa3dd48e1abe42b440514a8c8dbe592ca2bec9109d/th2_grpc_conn-0.0.1.tar.gz",
    "platform": "",
    "description": "# th2 conn gRPC library (0.0.1)\n\nThis library contains proto messages and `conn` service with RPC methods which can be used in implementation of th2 conn. See [conn.proto](src/main/proto/th2_grpc_conn/conn.proto \"conn.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 a package for Java, run the following command:\n\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n       -Purl=${URL} \\ \n       -Puser=${USER} \\\n       -Ppassword=${PASSWORD}\n```\n\n`URL`, `USER` and `PASSWORD` 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_conn",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/th2-net/th2-grpc-conn"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "88f0c39641fda21e8233a9aa3dd48e1abe42b440514a8c8dbe592ca2bec9109d",
                "md5": "5ca8aeea761f4ee2e864b17755c109c6",
                "sha256": "e5d074a6526ecaa8f82f96c956cdd7600f155b428d7543066577ad7eaf74af50"
            },
            "downloads": -1,
            "filename": "th2_grpc_conn-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5ca8aeea761f4ee2e864b17755c109c6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5742,
            "upload_time": "2021-07-08T11:56:48",
            "upload_time_iso_8601": "2021-07-08T11:56:48.823035Z",
            "url": "https://files.pythonhosted.org/packages/88/f0/c39641fda21e8233a9aa3dd48e1abe42b440514a8c8dbe592ca2bec9109d/th2_grpc_conn-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-07-08 11:56:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "th2-net",
    "github_project": "th2-grpc-conn",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "th2-grpc-common",
            "specs": [
                [
                    "~=",
                    "3.1.2"
                ]
            ]
        }
    ],
    "lcname": "th2-grpc-conn"
}
        
Elapsed time: 0.10900s