th2-grpc-codec


Nameth2-grpc-codec JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/th2-net/th2-grpc-codec
Summaryth2_grpc_codec
upload_time2023-09-12 10:49:27
maintainer
docs_urlNone
authorTH2-devs
requires_python>=3.7
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements th2-grpc-common mypy-protobuf
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # th2 gRPC codec library (0.1.0)

This library contains proto messages and `Codec` service with RPC methods that are used in [th2 codec](https://github.com/th2-net/th2-codec "th2-codec"). See [codec.proto](src/main/proto/th2_grpc_codec/codec.proto "codec.proto") file for details. <br>
Tool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to the specified repositories.

## 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.

### 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

### 0.1.0

+ Updated grpc-common 4.3.0

### 0.0.2

+ Added 'encode' method
+ Updated serviceGeneratorVersion and grpcCommonVersion to support gRPC pins filters.

### 0.0.1

+ 'decode' method
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/th2-net/th2-grpc-codec",
    "name": "th2-grpc-codec",
    "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/dc/da/e8ffae2bcc588c0b25ade2484a5286bb949a4fcdb11895e36cbeea0e323c/th2_grpc_codec-0.1.0.tar.gz",
    "platform": null,
    "description": "# th2 gRPC codec library (0.1.0)\n\nThis library contains proto messages and `Codec` service with RPC methods that are used in [th2 codec](https://github.com/th2-net/th2-codec \"th2-codec\"). See [codec.proto](src/main/proto/th2_grpc_codec/codec.proto \"codec.proto\") file for details. <br>\nTool generates code from `.proto` files and uploads built packages (`.proto` files and generated code) to the specified repositories.\n\n## How to maintain a project\n1. Perform the necessary changes.\n2. Update the package version of Java in `gradle.properties` file.\n3. Update the package version of Python in `package_info.json` file.\n4. Commit everything.\n\n### Java\nIf you wish to manually create and publish a package for Java, run the following command:\n```\ngradle --no-daemon clean build publish artifactoryPublish \\\n       -Purl=${URL} \\ \n       -Puser=${USER} \\\n       -Ppassword=${PASSWORD}\n```\n`URL`, `USER` and `PASSWORD` are parameters for publishing.\n\n### Python\nIf you wish to manually create and publish a package for Python:\n1. Generate services with `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 using `twine`:\n    ```\n    pip install -r requirements.txt\n    pip install twine\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.\n\n## Release notes\n\n### 0.1.0\n\n+ Updated grpc-common 4.3.0\n\n### 0.0.2\n\n+ Added 'encode' method\n+ Updated serviceGeneratorVersion and grpcCommonVersion to support gRPC pins filters.\n\n### 0.0.1\n\n+ 'decode' method",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "th2_grpc_codec",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/th2-net/th2-grpc-codec"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dcdae8ffae2bcc588c0b25ade2484a5286bb949a4fcdb11895e36cbeea0e323c",
                "md5": "67e5805da1d392c458e78c77392c8927",
                "sha256": "9ecf289b7168c61b0139b15989f8992d3e8e1f9dd8bcb9f8607c51830805ffbe"
            },
            "downloads": -1,
            "filename": "th2_grpc_codec-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "67e5805da1d392c458e78c77392c8927",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5038,
            "upload_time": "2023-09-12T10:49:27",
            "upload_time_iso_8601": "2023-09-12T10:49:27.162258Z",
            "url": "https://files.pythonhosted.org/packages/dc/da/e8ffae2bcc588c0b25ade2484a5286bb949a4fcdb11895e36cbeea0e323c/th2_grpc_codec-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-12 10:49:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "th2-net",
    "github_project": "th2-grpc-codec",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "th2-grpc-common",
            "specs": [
                [
                    "==",
                    "4.3.0.dev0"
                ]
            ]
        },
        {
            "name": "mypy-protobuf",
            "specs": [
                [
                    "==",
                    "3.4"
                ]
            ]
        }
    ],
    "lcname": "th2-grpc-codec"
}
        
Elapsed time: 0.14820s