{"id":20894848,"url":"https://github.com/claimed-framework/boilerplate","last_synced_at":"2025-08-23T03:05:23.856Z","repository":{"id":208893364,"uuid":"722728371","full_name":"claimed-framework/boilerplate","owner":"claimed-framework","description":"A boilerplate project to get started with your own operators, workflows and CI/CD pipelines","archived":false,"fork":false,"pushed_at":"2023-11-23T21:19:10.000Z","size":11,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-12T19:28:43.412Z","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/claimed-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-23T20:01:39.000Z","updated_at":"2023-11-23T21:19:14.000Z","dependencies_parsed_at":"2023-11-23T21:26:59.756Z","dependency_job_id":"7fe5addf-a00f-4a04-915c-463aaaa0240a","html_url":"https://github.com/claimed-framework/boilerplate","commit_stats":null,"previous_names":["claimed-framework/boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/claimed-framework/boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claimed-framework%2Fboilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claimed-framework%2Fboilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claimed-framework%2Fboilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claimed-framework%2Fboilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/claimed-framework","download_url":"https://codeload.github.com/claimed-framework/boilerplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claimed-framework%2Fboilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271736883,"owners_count":24812006,"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","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-18T10:23:06.974Z","updated_at":"2025-08-23T03:05:23.836Z","avatar_url":"https://github.com/claimed-framework.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CLAIMED Boilerplate\nA boilerplate project to get started with your own operators, workflows and CI/CD pipelines\n\nIf you like CLAIMED, just give us a [star](https://github.com/claimed-framework/component-library) on our [main project](https://github.com/claimed-framework/component-library).\n\n## Installation\nIdeally [fork](https://github.com/claimed-framework/boilerplate/fork) this repository to get started with your own code immediately. Otherwise, just [clone](https://github.com/claimed-framework/boilerplate.git) it. \n\n## Setup\nCLAIMED runs best in a python virtual environment. So once you've cloned or forked the project and opened it in your favourite IDE, please create a virtual environment by running the following commands in the root directory of your forked/cloned project:\n\n`python -m venv .venv`\n\n`source ./.venv/bin/activate`\n\n`pip install claimed cwltool`\n\nCLAIMED also relies on DOCKER (we are working on a containerless target runtime for the C3 compiler, but for now you need it). So please install DOCKER according the instructions for your operating system.\n\nThis (and love) is all you need.\n\n## Create your first operator\n\nTo make life simple, we've provided boilerplate operator code. Change into the `operators` directory:\n\n`cd operators`\n\nThen execute the following command:\n\n`c3_create_operator --test_mode -r anything example_operator.py`\n\nAs long as you are in `--test_mode`, you can set the repositiry to a dummy value with `-r anything` as the resulting image is not pushed to the container registry.\n\n## Test your first operator in local mode using CWL (Common Workflow Language)\n\nYou will see some artifacts created. YAML files (e.g., kubeflow pipeline component, kubernetes job definition) and a example_operator.cwl. You can now execute this task using:\n\n`cwltool example_operator.cwl --num_values 23`\n\nYou should see some output like this:\n\n`\n2023-11-23 21:06:21,102 - root - INFO - Random values: [0.46335395 0.16080613 0.29429919 0.82020681 0.72263968 0.13268649\n 0.14216825 0.97550455 0.23171864 0.82288426 0.82183549 0.46068025\n 0.46725788 0.56821123 0.62938518 0.7982786  0.52429601 0.13117852\n 0.66231392 0.48726925 0.69951924 0.13506377 0.35280975]\n`\n\n## Congratulations, let's turn this into a locally executable workflow.\n\nChange to the `workflows` folder:\n\n`cd ../workflows`\n\nThere you've find a file called example_workflow.cwl, consiting of two steps, both calling the operator you've just created.\n\nStart this workflow with:\n\n`cwltool example_workflow.cwl`\n\nIf everything is correct, you should see the same output from before, but twice.\n\nCongratulations. Now it is up to you to add additional operators, call them in the workflow and add other workflows to this project.\n\nThis concludes this boilerplate. If you have questions or problems, please create an [issue](https://github.com/claimed-framework/boilerplate/issues). You can also find more [examples](https://github.com/claimed-framework/c3/tree/main/examples).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaimed-framework%2Fboilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclaimed-framework%2Fboilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaimed-framework%2Fboilerplate/lists"}