{"id":21514824,"url":"https://github.com/getindata/streaming-cli","last_synced_at":"2025-09-09T22:50:26.230Z","repository":{"id":39749335,"uuid":"429008803","full_name":"getindata/streaming-cli","owner":"getindata","description":"Python CLI for streaming platform","archived":false,"fork":false,"pushed_at":"2023-07-25T13:25:37.000Z","size":468,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-09T20:11:26.305Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getindata.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-17T10:54:40.000Z","updated_at":"2024-04-09T13:20:21.000Z","dependencies_parsed_at":"2023-02-17T20:31:25.617Z","dependency_job_id":null,"html_url":"https://github.com/getindata/streaming-cli","commit_stats":null,"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getindata%2Fstreaming-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getindata%2Fstreaming-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getindata%2Fstreaming-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getindata%2Fstreaming-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getindata","download_url":"https://codeload.github.com/getindata/streaming-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T23:53:06.087Z","updated_at":"2025-04-09T20:11:32.323Z","avatar_url":"https://github.com/getindata.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python Version](https://img.shields.io/badge/python-3.8-blue.svg)](https://github.com/getindata/streaming-cli)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![SemVer](https://img.shields.io/badge/semver-2.0.0-green)](https://semver.org/)\n[![PyPI version](https://badge.fury.io/py/streamingcli.svg)](https://pypi.org/project/streamingcli/)\n[![Downloads](https://pepy.tech/badge/streamingcli)](https://pepy.tech/badge/streamingcli)\n\n# Streaming platform CLI\n\n## Usage\n\n### Platform operations\n\n#### Environments\n\nYou can set up your own environment, which will allow you to connect to Ververica/K8S operator. You need to fill\nproperties within `config/\u003cenv_name\u003e` directory. `config/flink_deployment.yml` is default deployment descriptor file\nfor each environment (you can overwrite it using `--file-descriptor-path` flag). You can use jinja for templating\n(look at the tests for an example). `base` environment is the default environment. Others environment override\nparameters from `base`. You need to have in `base` or your own environment `profile.yml`\nfile with given schema:\n```yaml\ndeployment_mode: \u003cVVP|K8S_OPERATOR\u003e\ndocker_registry_url: \u003cdocker_registry_url\u003e\n```\nYou need also extra file(s) with Ververica/Kubernetes configuration\nand optionally other configuration used for templating.\n\nExample `vvp.yml`:\n```yaml\nvvp:\n  url: \u003cververica_url\u003e\n  namespace: \u003cververica_namespace\u003e\n  deployment_target: \u003csome_deployment_target\u003e\n  ```\n\nExample `k8s.yml`:\n```yaml\nk8s:\n  namespace: test_ns\n```\n\nFor most of the command, you can pass the environment name with `--env`\nor export environmental variable as `SCLI_ENV`.\n\n#### Deploying job\n\n```shell\nscli project deploy \\\n  --vvp-api-token \"x§11d091jd1jd9jasd0j\" \\\n  --docker-image-tag \"${CI_COMMIT_TAG}\" \\\n  --profile \"dev\"\n```\n\n#### Building job Docker image\n\n```shell\nscli project build \\\n  --docker-image-tag \"latest\"\n```\n\n#### Logging to Docker repository\n\n```shell\nscli docker login \\\n  --username \"user\" \\\n  --password \"password\" \\\n  --profile \"dev\"\n```\n\n\u003e Parameters`--docker-image-tag` is optional and has default value `latest`.\n\n### Providing certificates\nScli uses `requests` library to deploy jobs to Ververica Platform via REST Api. Currently `requests` does not support\nautomatic downloading of intermediate certificates so entire chain of certificates should be present before making\na http call\n\nexample:\n```sh\nsh -c 'CA_CERT_PATH=`python3 -c \"import requests; print(requests.certs.where())\"`;for CERT in certs/*; do cat ${CERT}; done \u003e\u003e ${CA_CERT_PATH}';\n\n```\n\n### Project operations\n\n## SCLI Development\n\n### Prerequisities ##\n\n* `pipenv`\n\n### Build\n\n* `make setup` - Install dependencies required to build a wheel package\n* `make cli/package` - Create a wheel package\n\n### Install\n\n* `make cli/install` - Install a wheel package\n* `make cli/install/force` - Reinstall a wheel package\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetindata%2Fstreaming-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetindata%2Fstreaming-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetindata%2Fstreaming-cli/lists"}