{"id":24794935,"url":"https://github.com/glassflow/glassflow-python-sdk","last_synced_at":"2026-02-18T10:09:46.543Z","repository":{"id":229060322,"uuid":"763532039","full_name":"glassflow/glassflow-python-sdk","owner":"glassflow","description":"GlassFlow Python SDK to publish and consume data to your pipelines at Glassflow.dev","archived":false,"fork":false,"pushed_at":"2026-02-06T08:35:51.000Z","size":5131,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-02-06T16:36:38.727Z","etag":null,"topics":["data","data-processing","datastreaming","python","real-time","sdk","stream-processing"],"latest_commit_sha":null,"homepage":"https://glassflow.dev/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glassflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-26T13:26:28.000Z","updated_at":"2026-01-10T11:42:47.000Z","dependencies_parsed_at":"2024-12-09T11:31:33.032Z","dependency_job_id":"e57bf9d6-d39e-4272-96a1-3b34ed01a5d5","html_url":"https://github.com/glassflow/glassflow-python-sdk","commit_stats":null,"previous_names":["glassflow/glassflow-python-sdk"],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/glassflow/glassflow-python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glassflow%2Fglassflow-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glassflow%2Fglassflow-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glassflow%2Fglassflow-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glassflow%2Fglassflow-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glassflow","download_url":"https://codeload.github.com/glassflow/glassflow-python-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glassflow%2Fglassflow-python-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29575401,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["data","data-processing","datastreaming","python","real-time","sdk","stream-processing"],"created_at":"2025-01-29T23:19:09.910Z","updated_at":"2026-02-18T10:09:46.534Z","avatar_url":"https://github.com/glassflow.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GlassFlow Python SDK\n\n\u003cp align=\"left\"\u003e\n  \u003ca target=\"_blank\" href=\"https://pypi.python.org/pypi/glassflow\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/glassflow.svg?labelColor=\u0026color=e69e3a\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://github.com/glassflow/glassflow-python-sdk/blob/main/LICENSE.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/l/glassflow.svg?labelColor=\u0026color=e69e3a\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://pypi.python.org/pypi/glassflow\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/glassflow.svg?labelColor=\u0026color=e69e3a\"\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca target=\"_blank\" href=\"(https://github.com/glassflow/glassflow-python-sdk/actions\"\u003e\n    \u003cimg src=\"https://github.com/glassflow/glassflow-python-sdk/workflows/Test/badge.svg?labelColor=\u0026color=e69e3a\"\u003e\n  \u003c/a\u003e\n\u003c!-- Pytest Coverage Comment:Begin --\u003e\n  \u003cimg src=https://img.shields.io/badge/coverage-92%25-brightgreen\u003e\n\u003c!-- Pytest Coverage Comment:End --\u003e\n\u003c/p\u003e\n\nA Python SDK for creating and managing data pipelines between Kafka and ClickHouse.\n\n## Features\n\n- Create and manage data pipelines between Kafka and ClickHouse\n- Deduplication of events during a time window based on a key\n- Temporal joins between topics based on a common key with a given time window\n- Schema validation and configuration management\n\n## Installation\n\n```bash\npip install glassflow\n```\n\n## Quick Start\n\n### Initialize client\n\n```python\nfrom glassflow.etl import Client\n\n# Initialize GlassFlow client\nclient = Client(host=\"your-glassflow-etl-url\")\n```\n\n### Create a pipeline\n\n```python\npipeline_config = {\n    \"version\": \"v2\",\n    \"pipeline_id\": \"my-pipeline-id\",\n    \"source\": {\n      \"type\": \"kafka\",\n      \"connection_params\": {\n        \"brokers\": [\n          \"http://my.kafka.broker:9093\"\n        ],\n        \"protocol\": \"PLAINTEXT\",\n        \"mechanism\": \"NO_AUTH\"\n      },\n      \"topics\": [\n        {\n          \"consumer_group_initial_offset\": \"latest\",\n          \"name\": \"users\",\n          \"deduplication\": {\n            \"enabled\": True,\n            \"id_field\": \"event_id\",\n            \"id_field_type\": \"string\",\n            \"time_window\": \"1h\"\n          }\n        }\n      ]\n    },\n    \"join\": {\n      \"enabled\": False\n    },\n    \"sink\": {\n      \"type\": \"clickhouse\",\n      \"host\": \"http://my.clickhouse.server\",\n      \"port\": \"9000\",\n      \"database\": \"default\",\n      \"username\": \"default\",\n      \"password\": \"c2VjcmV0\",\n      \"secure\": False,\n      \"max_batch_size\": 1000,\n      \"max_delay_time\": \"30s\",\n      \"table\": \"users_dedup\"\n    },\n    \"schema\": {\n      \"fields\": [\n        {\n          \"source_id\": \"users\",\n          \"name\": \"event_id\",\n          \"type\": \"string\",\n          \"column_name\": \"event_id\",\n          \"column_type\": \"UUID\"\n        },\n        {\n          \"source_id\": \"users\",\n          \"field_name\": \"user_id\",\n          \"column_name\": \"user_id\",\n          \"column_type\": \"UUID\"\n        },\n        {\n          \"source_id\": \"users\",\n          \"name\": \"created_at\",\n          \"type\": \"string\",\n          \"column_name\": \"created_at\",\n          \"column_type\": \"DateTime\"\n        },\n        {\n          \"source_id\": \"users\",\n          \"name\": \"name\",\n          \"type\": \"string\",\n          \"column_name\": \"name\",\n          \"column_type\": \"String\"\n        },\n        {\n          \"source_id\": \"users\",\n          \"name\": \"email\",\n          \"type\": \"string\",\n          \"column_name\": \"email\",\n          \"column_type\": \"String\"\n        }\n      ]\n    }\n}\n\n# Create a pipeline\npipeline = client.create_pipeline(pipeline_config)\n```\n\n\n## Get pipeline\n\n```python\n# Get a pipeline by ID\npipeline = client.get_pipeline(\"my-pipeline-id\")\n```\n\n### List pipelines\n\n```python\npipelines = client.list_pipelines()\nfor pipeline in pipelines:\n    print(f\"Pipeline ID: {pipeline['pipeline_id']}\")\n    print(f\"Name: {pipeline['name']}\")\n    print(f\"Transformation Type: {pipeline['transformation_type']}\")\n    print(f\"Created At: {pipeline['created_at']}\")\n    print(f\"State: {pipeline['state']}\")\n```\n\n### Stop / Terminate / Resume Pipeline\n\n```python\npipeline = client.get_pipeline(\"my-pipeline-id\")\npipeline.stop()\nprint(pipeline.status)\n```\n\n```\nSTOPPING\n```\n\n```python\n# Stop a pipeline ungracefully (terminate)\nclient.stop_pipeline(\"my-pipeline-id\", terminate=True)\nprint(pipeline.status)\n```\n\n```\nTERMINATING\n```\n\n```python\npipeline = client.get_pipeline(\"my-pipeline-id\")\npipeline.resume()\nprint(pipeline.status)\n```\n\n```\nRESUMING\n```\n\n### Delete pipeline\n\nOnly stopped or terminated pipelines can be deleted.\n\n```python\n# Delete a pipeline\nclient.delete_pipeline(\"my-pipeline-id\")\n\n# Or delete via pipeline instance\npipeline.delete()\n```\n\n## Pipeline Configuration\n\nFor detailed information about the pipeline configuration, see [GlassFlow docs](https://docs.glassflow.dev/configuration/pipeline-json-reference).\n\n## Tracking\n\nThe SDK includes anonymous usage tracking to help improve the product. Tracking is enabled by default but can be disabled in two ways:\n\n1. Using an environment variable:\n```bash\nexport GF_TRACKING_ENABLED=false\n```\n\n2. Programmatically using the `disable_tracking` method:\n```python\nfrom glassflow.etl import Client\n\nclient = Client(host=\"my-glassflow-host\")\nclient.disable_tracking()\n```\n\nThe tracking collects anonymous information about:\n- SDK version\n- Platform (operating system)\n- Python version\n- Pipeline ID\n- Whether joins or deduplication are enabled\n- Kafka security protocol, auth mechanism used and whether authentication is disabled\n- Errors during pipeline creation and deletion\n\n## Development\n\n### Setup\n\n1. Clone the repository\n2. Create a virtual environment\n3. Install dependencies:\n\n```bash\nuv venv\nsource .venv/bin/activate\nuv pip install -e .[dev]\n```\n\n### Testing\n\n```bash\npytest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglassflow%2Fglassflow-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglassflow%2Fglassflow-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglassflow%2Fglassflow-python-sdk/lists"}