Add artifact support with ORAS to make them OCI format (#15)

* Add artifact support with ORAS to make them OCI format

Signed-off-by: kerthcet <kerthcet@gmail.com>

* format

Signed-off-by: kerthcet <kerthcet@gmail.com>

* fix ci test

Signed-off-by: kerthcet <kerthcet@gmail.com>

* fix ci test

Signed-off-by: kerthcet <kerthcet@gmail.com>

* fix ci test

Signed-off-by: kerthcet <kerthcet@gmail.com>

---------

Signed-off-by: kerthcet <kerthcet@gmail.com>

Author: kerthcet

.env.example

@@ -1,3 +1,4 @@
 # We use PG by default as the metadata database.
 METADATA_DB_URL=postgresql+psycopg2://user:pass@localhost:5432/mydb
+ARTIFACT_REGISTRY_URL=http://localhost:5000/
 LOG_LEVEL=INFO

.env.integration-test

@@ -0,0 +1,3 @@
+METADATA_DB_URL=sqlite:///:memory:
+ARTIFACT_REGISTRY_URL=europe-west2-docker.pkg.dev/runsandbox-449400/
+LOG_LEVEL=INFO

.env.test

@@ -0,0 +1,3 @@
+METADATA_DB_URL=sqlite:///:memory:
+ARTIFACT_REGISTRY_URL=localhost:5000
+LOG_LEVEL=INFO

.github/workflows/python-ci.yaml

@@ -25,7 +25,9 @@ jobs:
         run: poetry config virtualenvs.in-project true
 
       - name: Install dependencies
-        run: poetry install --no-interaction --no-ansi
+        run: poetry install --with dev --no-interaction --no-ansi
+
+      # Lint is already included in `make test`
 
       - name: Run tests
         run: make test

.gitignore

@@ -9,6 +9,7 @@ Dockerfile.cross
 
 # Test binary, build with `go test -c`
 *.test
+!.env.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out

Makefile

@@ -12,11 +12,15 @@ publish: build
 launch:
 	docker-compose up -d
 
-.PHONY: test
-test:
-	$(POETRY) run pytest
-
 .PHONY: format
 format:
-	ruff format .
-	ruff check --fix .
+	$(POETRY) run ruff format .
+	$(POETRY) run ruff check .
+
+.PHONY: test
+test: format
+	$(POETRY) run pytest tests/unit
+
+.PHONY: test-integration
+test-integration: format
+	$(POETRY) run pytest tests/integration

README.md

@@ -2,6 +2,24 @@
 
 **AlphaTrion** is an open-source and all-in-one platform to build LLM-powered applications. Named after the wise Transformer mentor, it embodies guidance and innovation to help developers build **production-ready** GenAI applications with ease. *Still under active development.*
 
+## How to Install
+
+### Install from PyPI
+
+```bash
+pip install alphatrion
+```
+
+### Install from Source
+
+Refer to [developer.md](./docs/development.md) for more information on how to set up your development environment.
+
+## Quick Start
+
+Still under active development now.
+
+Refer to [troubleshooting.md](./docs/troubleshooting.md) for common issues and solutions which may help.
+
 ## How to Contribute
 
 We welcome all kinds of contributions! Please see our [contribution guidelines](CONTRIBUTING.md) for more details.

alphatrion/artifact/__init__.py

@@ -0,0 +1,46 @@
+import os
+
+import oras.client
+
+from alphatrion import consts
+from alphatrion.runtime.runtime import Runtime
+
+SUCCESS_CODE = 201
+
+
+class Artifact:
+    def __init__(self, runtime: Runtime):
+        self._runtime = runtime
+        self._url = os.environ.get(consts.ARTIFACT_REGISTRY_URL)
+        self._url = self._url.replace("https://", "").replace("http://", "")
+        self._client = oras.client.OrasClient(
+            hostname=self._url.strip("/"), auth_backend="token"
+        )
+
+    def push(self, experiment_name: str, files: list[str], version: str = "latest"):
+        url = self._url if self._url.endswith("/") else f"{self._url}/"
+
+        target = f"{url}{self._runtime._project_id}/{experiment_name}:{version}"
+
+        try:
+            self._client.push(target, files=files)
+        except Exception as e:
+            raise RuntimeError("Failed to push artifacts") from e
+
+    def list_tags(self, experiment_name: str) -> list[str]:
+        url = self._url if self._url.endswith("/") else f"{self._url}/"
+        target = f"{url}{self._runtime._project_id}/{experiment_name}"
+        try:
+            tags = self._client.get_tags(target)
+            return tags
+        except Exception as e:
+            raise RuntimeError("Failed to list artifacts tags") from e
+
+    def delete_tags(self, experiment_name: str, versions: str | list):
+        url = self._url if self._url.endswith("/") else f"{self._url}/"
+        target = f"{url}{self._runtime._project_id}/{experiment_name}"
+
+        try:
+            self._client.delete_tags(target, tags=versions)
+        except Exception as e:
+            raise RuntimeError("Failed to delete tags") from e

alphatrion/artifact/artifact.py

@@ -1 +1,2 @@
 METADATA_DB_URL = "METADATA_DB_URL"
+ARTIFACT_REGISTRY_URL = "ARTIFACT_REGISTRY_URL"