{"id":45689876,"url":"https://github.com/gregorykogan/yt-framework","last_synced_at":"2026-02-24T16:03:50.612Z","repository":{"id":336423670,"uuid":"1149581939","full_name":"GregoryKogan/yt-framework","owner":"GregoryKogan","description":"Build scalable data pipelines on YTsaurus with automatic stage management, local development simulation, and more.","archived":false,"fork":false,"pushed_at":"2026-02-13T10:35:35.000Z","size":381,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-13T19:11:56.051Z","etag":null,"topics":["big-data","data-pipeline","distributed-computing","etl","framework","map-reduce","python","yt","ytsaurus"],"latest_commit_sha":null,"homepage":"https://yt-framework.readthedocs.io","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/GregoryKogan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2026-02-04T09:27:27.000Z","updated_at":"2026-02-13T11:53:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/GregoryKogan/yt-framework","commit_stats":null,"previous_names":["gregorykogan/yt-framework"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/GregoryKogan/yt-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregoryKogan%2Fyt-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregoryKogan%2Fyt-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregoryKogan%2Fyt-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregoryKogan%2Fyt-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GregoryKogan","download_url":"https://codeload.github.com/GregoryKogan/yt-framework/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregoryKogan%2Fyt-framework/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29790415,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T10:45:18.109Z","status":"ssl_error","status_checked_at":"2026-02-24T10:45:09.911Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["big-data","data-pipeline","distributed-computing","etl","framework","map-reduce","python","yt","ytsaurus"],"created_at":"2026-02-24T16:03:46.294Z","updated_at":"2026-02-24T16:03:50.608Z","avatar_url":"https://github.com/GregoryKogan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YT Framework\n\n![GitHub License](https://img.shields.io/github/license/GregoryKogan/yt-framework)\n[![PyPI - Version](https://img.shields.io/pypi/v/yt_framework)](https://pypi.org/project/yt-framework/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yt_framework)\n![Documentation Status](https://app.readthedocs.org/projects/yt-framework/badge/?version=latest)\n\n**[PyPI](https://pypi.org/project/yt-framework/) | [Documentation](https://yt-framework.readthedocs.io/en/latest/) | [Examples](https://github.com/GregoryKogan/yt-framework/tree/main/examples)**\n\n---\n\n## Overview\n\nA powerful Python framework for building and executing data processing pipelines on [YTsaurus](https://ytsaurus.tech/) (YT) clusters. YT Framework simplifies pipeline development with automatic stage discovery, seamless dev/prod mode switching, and comprehensive support for YT operations.\n\n## Architecture\n\nYT Framework follows a pipeline-based architecture where pipelines consist of stages, and stages execute operations.\n\n**Key Components:**\n\n- **Pipeline**: Orchestrates stages, their execution order, and configuration management\n- **Stages**: Reusable units of work that execute operations\n- **Operations**: Specific tasks (Map, Vanilla, YQL, S3, Table operations)\n- **Configuration**: YAML-based configuration system for flexible pipeline setup\n\n## Key Features\n\n- **Pipeline \u0026 Stage Architecture**: Organize complex workflows into reusable stages\n- **Automatic Stage Discovery**: No manual registration needed - just create stages and run\n- **Dev/Prod Modes**: Develop locally with file system simulation, deploy to YT cluster seamlessly\n- **Multiple Operation Types**: Support for Map, Vanilla, YQL, and S3 operations\n- **Code Upload**: Automatic code packaging and deployment to YT cluster\n- **Docker Support**: Custom Docker images for special dependencies\n- **Checkpoint Management**: Built-in support for ML model checkpoints\n- **Configuration Management**: Flexible YAML-based configuration with multiple config support\n\n## Installation\n\n### For Users\n\nInstall from [PyPI](https://pypi.org/project/yt-framework/):\n\n```bash\npip install yt-framework\n```\n\n### For Developers and Contributors\n\nInstall in editable mode from source:\n\n```bash\ngit clone https://github.com/GregoryKogan/yt-framework.git\ncd yt-framework\npip install -e .\n```\n\nFor development with testing tools:\n\n```bash\npip install -e \".[dev]\"\n```\n\nSee [Installation Guide](https://yt-framework.readthedocs.io/en/latest/#installation) for prerequisites and detailed setup instructions.\n\n## Quick Start\n\nCreate your first pipeline in 3 steps:\n\n**What you'll build:** A simple pipeline that creates a stage, logs a message, and demonstrates the basic framework structure.\n\n1. **Create pipeline structure**:\n\n   ```bash\n   mkdir my_pipeline \u0026\u0026 cd my_pipeline\n   mkdir -p stages/my_stage configs\n   ```\n\n2. **Create `pipeline.py`**:\n\n   ```python\n   from yt_framework.core.pipeline import DefaultPipeline\n   \n   if __name__ == \"__main__\":\n       DefaultPipeline.main()\n   ```\n\n3. **Create stage and config**:\n\n   ```python\n   # stages/my_stage/stage.py\n   from yt_framework.core.stage import BaseStage\n   \n   class MyStage(BaseStage):\n       def run(self, debug):\n           self.logger.info(\"Hello from YT Framework!\")\n           return debug\n   ```\n\n   ```yaml\n   # configs/config.yaml\n   stages:\n     enabled_stages:\n       - my_stage\n   \n   pipeline:\n     mode: \"dev\"  # Use \"dev\" for local development\n   ```\n\n**Run your pipeline:**\n\n```bash\npython pipeline.py\n```\n\n**Next Steps:**\n\n- See the [Quick Start Guide](https://yt-framework.readthedocs.io/en/latest/#quick-start) for a complete example with table operations\n- Explore [Examples](https://github.com/GregoryKogan/yt-framework/tree/main/examples) to see more complex use cases\n- Read about [Pipelines and Stages](https://yt-framework.readthedocs.io/en/latest/pipelines-and-stages.html) in the documentation\n\n## Examples\n\nThe [`examples/`](https://github.com/GregoryKogan/yt-framework/tree/main/examples) directory contains comprehensive examples demonstrating most framework features.\nEach example includes a README explaining what it demonstrates and how to run it.\n\n## Requirements\n\n### Prerequisites Checklist\n\n- [ ] **Python 3.11+** installed\n- [ ] **YT cluster access and credentials** (for production mode)\n\n### YT Cluster Requirements\n\nWhen running pipelines in production mode, code from `ytjobs` executes on YT cluster nodes. The cluster's Docker image (default or custom) must include:\n\n- **Python 3.11+**\n- **ytsaurus-client** \u003e= 0.13.0 (for checkpoint operations)\n- **boto3** == 1.35.99 (for S3 operations)\n- **botocore** == 1.35.99 (auto-installed with boto3)\n\n**Important:** Ensure your cluster's default Docker image satisfies these dependencies, or always use custom Docker images for your pipelines. See [Cluster Requirements](https://yt-framework.readthedocs.io/en/latest/configuration/cluster-requirements.html) and [Custom Docker Images](https://yt-framework.readthedocs.io/en/latest/advanced/docker.html) for details.\n\n## Documentation\n\n**Full documentation available at: [yt-framework.readthedocs.io](https://yt-framework.readthedocs.io/en/latest/)**\n\nFor local development, source documentation is available in the [`docs/`](docs/) directory.\n\n**[Examples](https://github.com/GregoryKogan/yt-framework/tree/main/examples)** - Complete working examples for most features\n\n## Getting Help\n\n- **Documentation**: Check the [full documentation](https://yt-framework.readthedocs.io/en/latest/) for detailed guides\n- **Troubleshooting**: See the [Troubleshooting Guide](https://yt-framework.readthedocs.io/en/latest/troubleshooting/index.html) for common issues\n- **Examples**: Browse [working examples](https://github.com/GregoryKogan/yt-framework/tree/main/examples) to see how features are used\n- **GitHub Issues**: Report bugs or request features on [GitHub Issues](https://github.com/GregoryKogan/yt-framework/issues)\n- **Questions**: Open a GitHub issue with the `question` label\n\n## Contributing\n\nWe welcome contributions! Whether it's bug fixes, new features, documentation improvements, or examples, your help makes YT Framework better.  \nSee [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregorykogan%2Fyt-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgregorykogan%2Fyt-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregorykogan%2Fyt-framework/lists"}