https://github.com/claimed-framework/c3
https://github.com/claimed-framework/c3
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/claimed-framework/c3
- Owner: claimed-framework
- License: apache-2.0
- Created: 2021-06-16T08:09:21.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T16:12:43.000Z (over 1 year ago)
- Last Synced: 2025-05-02T21:03:20.288Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 305 KB
- Stars: 0
- Watchers: 2
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://bestpractices.coreinfrastructure.org/projects/6718)
[](https://github.com/claimed-framework/component-library/issues)
# C3 - the CLAIMED Component Compiler
**TL;DR**
- takes arbitrary assets (Jupyter notebooks, python scripts, R scripts) as input
- automatically creates container images and pushes to container registries
- automatically installs all required dependencies into the container image
- creates KubeFlow Pipeline components (target workflow execution engines are pluggable)
- creates Kubernetes job configs for execution on Kubernetes/Openshift clusters
- can be triggered from CICD pipelines
To learn more on how this library works in practice, please have a look at the following [video](https://www.youtube.com/watch?v=FuV2oG55C5s)
## Related work
[Ploomber](https://github.com/ploomber/ploomber)
[Orchest](https://www.orchest.io/)
## Getting started
### Install
```sh
pip install claimed
```
### Usage
Just run the following command with your python script or notebook:
```sh
c3_create_operator ".py" --repository "/"
```
Your code needs to follow certain requirements which are explained in [Getting Started](https://github.com/claimed-framework/c3/blob/main/GettingStarted.md).
## Getting Help
```sh
c3_create_operator --help
```
We welcome your questions, ideas, and feedback. Please create an [issue](https://github.com/claimed-framework/component-library/issues) or a [discussion thread](https://github.com/claimed-framework/component-library/discussions).
Please see [VULNERABILITIES.md](VULNERABILITIES.md) for reporting vulnerabilities.
## Contributing to CLAIMED
Interested in helping make CLAIMED better? We encourage you to take a look at our
[Contributing](CONTRIBUTING.md) page.
## License
This software is released under Apache License v2.0.