ciel 0.21.0.dev1__tar.gz → 1.0.0__tar.gz

{ciel-0.21.0.dev1 → ciel-1.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: ciel
-Version: 0.21.0.dev1
+Version: 1.0.0
 Summary: An PDK builder/version manager for PDKs in the open_pdks format
 Home-page: https://github.com/fossi-foundation/ciel
 License: Apache-2.0
-Author: Efabless Corporation and Contributors
-Author-email: donn@efabless.com
+Author: Mohamed Gaber
+Author-email: me@donn.website
 Requires-Python: >=3.8
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/__main__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,11 +29,7 @@ from .common import (
     resolve_version,
 )
 from .click_common import (
-    opt,
-    opt_build,
-    opt_push,
     opt_pdk_root,
-    opt_token,
 )
 from .manage import (
     print_installed_list,
@@ -41,6 +41,8 @@ from .build import (
     build_cmd,
     push_cmd,
 )
+from .github import opt_github_token
+from .source import opt_data_source
 
 
 @click.command("output")
@@ -113,9 +115,10 @@ def rm_cmd(pdk_root, pdk, version):
 
 
 @click.command("ls")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
-def list_cmd(pdk_root, pdk):
+def list_cmd(data_source, pdk_root, pdk):
     """Lists PDK versions that are locally installed. JSON if not outputting to a tty."""
 
     pdk_versions = Version.get_all_installed(pdk_root, pdk)
@@ -125,6 +128,7 @@ def list_cmd(pdk_root, pdk):
         print_installed_list(
             pdk_root,
             pdk,
+            data_source=data_source,
             console=console,
             installed_list=pdk_versions,
         )
@@ -133,14 +137,14 @@ def list_cmd(pdk_root, pdk):
 
 
 @click.command("ls-remote")
-@opt_token
+@opt_github_token
+@opt_data_source
 @opt_pdk_root
-def list_remote_cmd(pdk_root, pdk):
+def list_remote_cmd(data_source, pdk_root, pdk):
     """Lists PDK versions that are remotely available. JSON if not outputting to a tty."""
 
     try:
-        all_versions = Version._from_github()
-        pdk_versions = all_versions.get(pdk) or []
+        pdk_versions = data_source.get_available_versions(pdk)
 
         if sys.stdout.isatty():
             console = Console()
@@ -148,6 +152,13 @@ def list_remote_cmd(pdk_root, pdk):
         else:
             for version in pdk_versions:
                 print(version.name)
+    except ValueError as e:
+        if sys.stdout.isatty():
+            console = Console()
+            console.print(f"[red]{e}")
+        else:
+            print(f"{e}", file=sys.stderr)
+        sys.exit(-1)
     except httpx.HTTPStatusError as e:
         if sys.stdout.isatty():
             console = Console()
@@ -184,7 +195,8 @@ def path_cmd(pdk_root, pdk, version):
 
 
 @click.command("enable")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
 @click.option(
     "-f",
@@ -202,6 +214,7 @@ def path_cmd(pdk_root, pdk, version):
 )
 @click.argument("version", required=False)
 def enable_cmd(
+    data_source,
     pdk_root,
     pdk,
     tool_metadata_file_path,
@@ -234,6 +247,7 @@ def enable_cmd(
             version,
             include_libraries=include_libraries,
             output=console,
+            data_source=data_source,
         )
     except Exception as e:
         console.print(f"[red]{e}")
@@ -241,7 +255,8 @@ def enable_cmd(
 
 
 @click.command("fetch")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
 @click.option(
     "-f",
@@ -259,6 +274,7 @@ def enable_cmd(
 )
 @click.argument("version", required=False)
 def fetch_cmd(
+    data_source,
     pdk_root,
     pdk,
     tool_metadata_file_path,
@@ -287,6 +303,7 @@ def fetch_cmd(
 
     try:
         version = fetch(
+            data_source=data_source,
             pdk_root=pdk_root,
             pdk=pdk,
             version=version,
@@ -300,79 +317,6 @@ def fetch_cmd(
         exit(-1)
 
 
-@click.command("enable_or_build", hidden=True)
-@opt_token
-@opt_pdk_root
-@opt_push
-@opt_build
-@opt("--also-push/--dont-push", default=False, help="Also push.")
-@click.option(
-    "-f",
-    "--metadata-file",
-    "tool_metadata_file_path",
-    default=None,
-    help="Explicitly define a tool metadata file instead of searching for a metadata file",
-)
-@click.argument("version")
-def enable_or_build_cmd(
-    include_libraries,
-    jobs,
-    pdk_root,
-    pdk,
-    owner,
-    repository,
-    pre,
-    clear_build_artifacts,
-    tool_metadata_file_path,
-    also_push,
-    version,
-    use_repo_at,
-    push_libraries,
-):
-    """
-    Attempts to activate a given PDK version. If the version is not found locally or remotely,
-    it will instead attempt to build said version.
-
-    Parameters: <version>
-    """
-    if include_libraries == ():
-        include_libraries = None
-    if push_libraries == ():
-        push_libraries = include_libraries
-
-    console = Console()
-    try:
-        version = resolve_version(version, tool_metadata_file_path)
-    except Exception as e:
-        console.print(f"Could not determine open_pdks version: {e}")
-        exit(-1)
-    try:
-        enable(
-            pdk_root=pdk_root,
-            pdk=pdk,
-            version=version,
-            build_if_not_found=True,
-            also_push=also_push,
-            build_kwargs={
-                "include_libraries": include_libraries,
-                "jobs": jobs,
-                "clear_build_artifacts": clear_build_artifacts,
-                "use_repo_at": use_repo_at,
-            },
-            push_kwargs={
-                "owner": owner,
-                "repository": repository,
-                "pre": pre,
-                "push_libraries": push_libraries,
-            },
-            include_libraries=include_libraries,
-            output=console,
-        )
-    except Exception as e:
-        console.print(f"[red]{e}")
-        exit(-1)
-
-
 @click.group()
 @click.version_option(
     __version__,
@@ -404,7 +348,6 @@ cli.add_command(list_cmd)
 cli.add_command(list_remote_cmd)
 cli.add_command(enable_cmd)
 cli.add_command(fetch_cmd)
-cli.add_command(enable_or_build_cmd)
 
 try:
     import ssl  # noqa: F401

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/build/__init__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,7 +32,7 @@ from rich.progress import Progress
 from ..github import (
     GitHubSession,
     get_commit_date,
-    volare_repo,
+    opt_github_token,
 )
 from ..common import (
     Version,
@@ -40,7 +44,6 @@ from ..click_common import (
     opt_push,
     opt_build,
     opt_pdk_root,
-    opt_token,
 )
 from ..families import Family
 
@@ -79,7 +82,7 @@ def build(
 
 
 @click.command("build")
-@opt_token
+@opt_github_token
 @opt_pdk_root
 @opt_build
 @click.option(
@@ -135,16 +138,14 @@ def push(
     pdk,
     version,
     *,
-    owner=volare_repo.owner,
-    repository=volare_repo.name,
+    owner,
+    repository,
     pre=False,
     push_libraries=None,
-    session: Optional[GitHubSession] = None,
 ):
     family = Family.by_name[pdk]
 
-    if session is None:
-        session = GitHubSession()
+    session = GitHubSession()
     if session.github_token is None:
         raise TypeError("No GitHub token was provided.")
 
@@ -231,7 +232,7 @@ def push(
 
 
 @click.command("push", hidden=True)
-@opt_token
+@opt_github_token
 @opt_pdk_root
 @opt_push
 @click.argument("version")

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/click_common.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,12 +17,11 @@
 # limitations under the License.
 import os
 from functools import partial
-from typing import Callable, Optional
+from typing import Callable
 
 import click
 
 from .common import VOLARE_RESOLVED_HOME
-from .github import volare_repo, GitHubSession
 
 opt = partial(click.option, show_default=True)
 
@@ -77,12 +80,10 @@ def opt_build(function: Callable):
 
 
 def opt_push(function: Callable):
-    function = opt("-o", "--owner", default=volare_repo.owner, help="Repository Owner")(
-        function
-    )
-    function = opt("-r", "--repository", default=volare_repo.name, help="Repository")(
+    function = opt("-o", "--owner", default="efabless", help="Repository Owner")(
         function
     )
+    function = opt("-r", "--repository", default="volare", help="Repository")(function)
     function = opt(
         "--pre/--prod", default=False, help="Push as pre-release or production"
     )(function)
@@ -95,25 +96,3 @@ def opt_push(function: Callable):
         help="Push only libraries in this list. You can use -L multiple times to include multiple libraries. Pass 'None' to push all libraries built.",
     )(function)
     return function
-
-
-def set_token_cb(
-    ctx: click.Context,
-    param: click.Parameter,
-    value: Optional[str],
-):
-    GitHubSession.Token.override = value
-
-
-def opt_token(function: Callable) -> Callable:
-    function = opt(
-        "-t",
-        "--token",
-        "session",
-        default=None,
-        required=False,
-        expose_value=False,
-        help="Replace the GitHub token used for GitHub requests, which is by default the value of the environment variable GITHUB_TOKEN or None.",
-        callback=set_token_cb,
-    )(function)
-    return function

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/common.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Modified from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,14 +16,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import os
-import re
 import shutil
 import pathlib
 from datetime import datetime
 from dataclasses import dataclass
-from typing import Iterable, Optional, List, Dict, Tuple
+from typing import Optional, List
 
-from . import github
 from .families import Family
 
 # -- Assorted Helper Functions
@@ -142,72 +144,6 @@ class Version(object):
             if os.path.isdir(os.path.join(versions_dir, version))
         ]
 
-    @classmethod
-    def _from_github(
-        Self,
-        session: Optional[github.GitHubSession] = None,
-    ) -> Dict[str, List["Version"]]:
-        releases = github.get_releases(session)
-
-        rvs_by_pdk: Dict[str, List["Version"]] = {}
-
-        commit_rx = re.compile(r"released on ([\d\-\:TZ]+)")
-
-        for release in releases:
-            if release["draft"]:
-                continue
-            family, hash = release["tag_name"].rsplit("-", maxsplit=1)
-
-            upload_date = date_from_iso8601(release["published_at"])
-            commit_date = None
-
-            commit_date_match = commit_rx.search(release["body"])
-            if commit_date_match is not None:
-                commit_date = date_from_iso8601(commit_date_match[1])
-
-            remote_version = Self(
-                name=hash,
-                pdk=family,
-                commit_date=commit_date,
-                upload_date=upload_date,
-                prerelease=release["prerelease"],
-            )
-
-            if rvs_by_pdk.get(family) is None:
-                rvs_by_pdk[family] = rvs_by_pdk.get(family) or []
-
-            rvs_by_pdk[family].append(remote_version)
-
-        for family in rvs_by_pdk.keys():
-            rvs_by_pdk[family].sort(reverse=True)
-
-        return rvs_by_pdk
-
-    def get_release_links(
-        self,
-        scl_filter: Iterable[str],
-        include_common: bool,
-        session: Optional[github.GitHubSession] = None,
-    ) -> List[Tuple[str, str]]:
-        release = github.get_release_links(f"{self.pdk}-{self.name}", session)
-
-        assets = release["assets"]
-        zst_files = []
-        for asset in assets:
-            if asset["name"].endswith(".tar.zst"):
-                asset_scl = asset["name"][:-8]
-                if (
-                    asset_scl == "common" and include_common
-                ) or asset_scl in scl_filter:
-                    zst_files.append((asset["name"], asset["browser_download_url"]))
-
-        if len(zst_files) == 0:
-            raise ValueError(
-                f"No files found for standard cell libraries: {scl_filter}."
-            )
-
-        return zst_files
-
 
 def resolve_version(
     version: Optional[str],

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/github.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Modified from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,11 +16,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import os
-import subprocess
 import sys
+import click
+import subprocess
 from datetime import datetime
 from dataclasses import dataclass
-from typing import Any, ClassVar, List, Mapping, Optional
+from typing import Any, ClassVar, Optional, Callable
 
 import httpx
 import ssl
@@ -28,6 +33,10 @@ class RepoInfo:
     owner: str
     name: str
 
+    @classmethod
+    def from_id(self, id_str: str) -> "RepoInfo":
+        return RepoInfo(*id_str.split("/", maxsplit=1))
+
     @property
     def id(self):
         return f"{self.owner}/{self.name}"
@@ -41,11 +50,6 @@ class RepoInfo:
         return f"https://api.github.com/repos/{self.id}"
 
 
-volare_repo = RepoInfo(
-    os.getenv("VOLARE_REPO_OWNER", "efabless"),
-    os.getenv("VOLARE_REPO_NAME", "volare"),
-)
-
 opdks_repo = RepoInfo(
     os.getenv("OPDKS_REPO_OWNER", "RTimothyEdwards"),
     os.getenv("OPDKS_REPO_NAME", "open_pdks"),
@@ -68,16 +72,10 @@ class GitHubSession(httpx.Client):
             # 0. Lowest priority: ghcli
             try:
                 token = subprocess.check_output(
-                    [
-                        "gh",
-                        "auth",
-                        "token",
-                    ],
+                    ["gh", "auth", "token"],
                     encoding="utf8",
                 ).strip()
-            except FileNotFoundError:
-                pass
-            except subprocess.CalledProcessError:
+            except Exception:
                 pass
 
             # 1. Higher priority: environment GITHUB_TOKEN
@@ -168,17 +166,23 @@ def get_commit_date(
     return commit_date
 
 
-def get_releases(session: Optional[GitHubSession] = None) -> List[Mapping[str, Any]]:
-    if session is None:
-        session = GitHubSession()
-
-    return session.api(volare_repo, "/releases", "get", params={"per_page": 100})
-
-
-def get_release_links(
-    release: str, session: Optional[GitHubSession] = None
-) -> Mapping[str, Any]:
-    if session is None:
-        session = GitHubSession()
-
-    return session.api(volare_repo, f"/releases/tags/{release}", "get")
+def set_token_cb(
+    ctx: click.Context,
+    param: click.Parameter,
+    value: Optional[str],
+):
+    GitHubSession.Token.override = value
+
+
+def opt_github_token(function: Callable) -> Callable:
+    function = click.option(
+        "-t",
+        "--github-token",
+        default=None,
+        required=False,
+        expose_value=False,
+        show_default=True,
+        help="Replace the token used for GitHub requests, which is by default the value of the environment variable GITHUB_TOKEN or None.",
+        callback=set_token_cb,
+    )(function)
+    return function

{ciel-0.21.0.dev1 → ciel-1.0.0}/ciel/manage.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Modified from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,7 +31,6 @@ import zstandard as zstd
 from rich.console import Console
 
 from .build.git_multi_clone import mkdirp
-from .github import GitHubSession
 from .common import (
     Version,
     get_versions_dir,
@@ -35,6 +38,7 @@ from .common import (
 )
 from .build import build, push
 from .families import Family
+from .source import DataSource
 
 
 class VersionNotFound(Exception):
@@ -45,9 +49,9 @@ def print_installed_list(
     pdk_root: str,
     pdk: str,
     *,
+    data_source: DataSource,
     console: Console,
     installed_list: List[Version],
-    session: Optional[GitHubSession] = None,
 ):
     if len(installed_list) == 0:
         console.print("[red]No PDKs installed.")
@@ -56,8 +60,7 @@ def print_installed_list(
     versions = installed_list
 
     try:
-        all_remote_versions = Version._from_github(session)
-        remote_versions = all_remote_versions.get(pdk) or []
+        remote_versions = data_source.get_available_versions(pdk)
         remote_version_dict = {rv.name: rv for rv in remote_versions}
         for installed in installed_list:
             remote_version = remote_version_dict.get(installed.name)
@@ -118,17 +121,14 @@ def fetch(
     pdk: str,
     version: str,
     *,
+    data_source: DataSource,
     build_if_not_found=False,
     also_push=False,
     build_kwargs: dict = {},
     push_kwargs: dict = {},
     include_libraries: Optional[Iterable[str]] = None,
     output: Union[Console, io.TextIOWrapper] = Console(),
-    session: Optional[GitHubSession] = None,
 ) -> Version:
-    if session is None:
-        session = GitHubSession()
-
     console = output
     if not isinstance(console, Console):
         console = Console(file=console)
@@ -178,16 +178,18 @@ def fetch(
 
         tarball_paths = []
         try:
-            release_link_list = version_object.get_release_links(
-                missing_libraries,
-                include_common=common_missing,
-                session=session,
-            )
+            client, assets = data_source.get_downloads_for_version(version_object)
+            assets_filtered = []
+            for asset in assets:
+                if asset.content == "common" and common_missing:
+                    assets_filtered.append(asset)
+                elif asset.content in missing_libraries:
+                    assets_filtered.append(asset)
             tarball_directory = tempfile.TemporaryDirectory(suffix=".ciel")
-            for name, link in release_link_list:
-                tarball_path = os.path.join(tarball_directory.name, name)
+            for asset in assets_filtered:
+                tarball_path = os.path.join(tarball_directory.name, asset.filename)
                 tarball_paths.append(tarball_path)
-                with session.stream("get", link) as r, rich.progress.Progress(
+                with client.stream("get", asset.url) as r, rich.progress.Progress(
                     console=console
                 ) as p:
                     total_str: Optional[str] = r.headers.get("Content-length", None)
@@ -195,7 +197,7 @@ def fetch(
                     if total_str is not None:
                         total_int = int(total_str)
                     task = p.add_task(
-                        f"Downloading {name}…",
+                        f"Downloading {asset.filename}…",
                         total=total_int,
                     )
                     r.raise_for_status()
@@ -204,7 +206,7 @@ def fetch(
                             p.advance(task, advance=len(chunk))
                             f.write(chunk)
 
-                with console.status(f"Unpacking {name}…"):
+                with console.status(f"Unpacking {asset.filename}…"):
                     stream = zstd.open(tarball_path, mode="rb")
                     with tarfile.TarFile(fileobj=stream, mode="r") as tf:
                         for file in tf:
@@ -216,7 +218,7 @@ def fetch(
                             io = tf.extractfile(file)
                             if io is None:
                                 raise IOError(
-                                    f"Failed to unpack file in {name}'s tarball: {file.name}."
+                                    f"Failed to unpack file in {asset.filename}'s tarball: {file.name}."
                                 )
                             with open(final_path, "wb") as f:
                                 f.write(io.read())
@@ -242,7 +244,6 @@ def fetch(
                         pdk_root=pdk_root,
                         pdk=pdk,
                         version=version,
-                        session=session,
                         **push_kwargs,
                     )
             else:
@@ -285,16 +286,14 @@ def enable(
     pdk: str,
     version: str,
     *,
+    data_source: DataSource,
     build_if_not_found: bool = False,
     also_push: bool = False,
     build_kwargs: dict = {},
     push_kwargs: dict = {},
     include_libraries: Optional[List[str]] = None,
     output: Union[Console, io.TextIOWrapper] = Console(),
-    session: Optional[GitHubSession] = None,
 ) -> Version:
-    if session is None:
-        session = GitHubSession()
 
     console = output
     if not isinstance(console, Console):
@@ -315,13 +314,13 @@ def enable(
         pdk_root,
         pdk,
         version,
+        data_source=data_source,
         build_if_not_found=build_if_not_found,
         also_push=also_push,
         build_kwargs=build_kwargs,
         push_kwargs=push_kwargs,
         include_libraries=include_libraries,
         output=output,
-        session=session,
     )
 
     current_file = os.path.join(get_ciel_dir(pdk_root, pdk), "current")

ciel-1.0.0/ciel/source.py

@@ -0,0 +1,229 @@
+# Copyright 2025 The American University in Cairo
+#
+# Modified from the Volare project
+#
+# Copyright 2022-2023 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import re
+import sys
+from dataclasses import dataclass
+from typing import Dict, ClassVar, List, Tuple, Type, Callable
+
+import click
+import httpx
+
+from .github import GitHubSession, RepoInfo
+from .common import Version, date_from_iso8601
+
+
+@dataclass
+class Asset:
+    content: str
+    filename: str
+    url: str
+
+
+class DataSource(object):
+    factory: ClassVar[Dict[str, Type["DataSource"]]] = {}
+    default: ClassVar["DataSource"]
+
+    def __init__(self, argument: str):
+        raise NotImplementedError()
+
+    def get_available_versions(self, pdk: str) -> List[Version]:
+        raise NotImplementedError()
+
+    def get_downloads_for_version(
+        self, version: Version
+    ) -> Tuple[httpx.Client, List[Asset]]:
+        raise NotImplementedError()
+
+
+class GitHubReleasesDataSource(DataSource):
+    def __init__(self, repo_id: str):
+        self.session = GitHubSession()
+        self.repo = RepoInfo.from_id(repo_id)
+
+    def get_available_versions(self, pdk: str) -> List[Version]:
+        page = 1
+        last = self.session.api(
+            self.repo,
+            "/releases",
+            "get",
+            params={"page": 1, "per_page": 100},
+        )
+        releases = last
+        while len(last) == 100:
+            page += 1
+            last = self.session.api(
+                self.repo,
+                "/releases",
+                "get",
+                params={"page": 1, "per_page": 100},
+            )
+            releases += last
+
+        versions = []
+        commit_rx = re.compile(r"released on ([\d\-\:TZ]+)")
+        for release in releases:
+            if release["draft"]:
+                continue
+
+            family, hash = release["tag_name"].rsplit("-", maxsplit=1)
+
+            if pdk != family:
+                continue
+
+            upload_date = date_from_iso8601(release["published_at"])
+            commit_date = None
+
+            commit_date_match = commit_rx.search(release["body"])
+            if commit_date_match is not None:
+                commit_date = date_from_iso8601(commit_date_match[1])
+
+            remote_version = Version(
+                name=hash,
+                pdk=family,
+                commit_date=commit_date,
+                upload_date=upload_date,
+                prerelease=release["prerelease"],
+            )
+            versions.append(remote_version)
+
+        versions.sort(reverse=True)
+        if len(versions) == 0:
+            raise ValueError(
+                f"No versions found for '{pdk}' on github.com/{self.repo.id}"
+            )
+        return versions
+
+    def get_downloads_for_version(
+        self, version: Version
+    ) -> Tuple[httpx.Client, List[Asset]]:
+        release = self.session.api(
+            self.repo,
+            f"/releases/tags/{version.pdk}-{version.name}",
+            "get",
+        )
+
+        assets = release["assets"]
+        zst_files = []
+        for asset in assets:
+            if asset["name"].endswith(".tar.zst"):
+                content = asset["name"][:-8]
+                zst_files.append(
+                    Asset(content, asset["name"], asset["browser_download_url"])
+                )
+        return (self.session, zst_files)
+
+
+DataSource.factory["github-releases"] = GitHubReleasesDataSource
+
+
+class StaticWebDataSource(DataSource):
+    def __init__(self, base_url: str):
+        self.session = GitHubSession()
+        self.base_url = base_url
+
+    def get_available_versions(self, pdk: str) -> List[Version]:
+        req = self.session.request("GET", self.base_url + f"/{pdk}/manifest.json")
+        try:
+            req.raise_for_status()
+        except httpx.HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ValueError(
+                    f"No versions found for '{pdk}' at '{self.base_url}'"
+                ) from None
+            else:
+                raise e from None
+        manifest = req.json()
+
+        versions = []
+        for version in manifest["versions"]:
+            remote_version = Version(
+                name=version["version"],
+                pdk=manifest["pdk"],
+                commit_date=date_from_iso8601(version["date"]),
+                prerelease=version.get("prerelease", False),
+            )
+            versions.append(remote_version)
+
+        versions.sort(reverse=True)
+        if len(versions) == 0:
+            raise ValueError(f"No versions found for '{pdk}' on '{self.base_url}'")
+        return versions
+
+    def get_downloads_for_version(
+        self, version: Version
+    ) -> Tuple[httpx.Client, List[Asset]]:
+        req = self.session.request(
+            "GET", self.base_url + f"/{version.pdk}/{version.name}/manifest.json"
+        )
+        try:
+            req.raise_for_status()
+        except httpx.HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ValueError(
+                    f"Manifest for '{version.pdk}/{version.name}' at '{self.base_url}'"
+                ) from None
+            else:
+                raise e from None
+        manifest = req.json()
+        assets = []
+        for asset in manifest["assets"]:
+            assets.append(Asset(**asset))
+        return (self.session, assets)
+
+
+DataSource.factory["static-web"] = StaticWebDataSource
+
+
+def data_source_cb(
+    ctx: click.Context,
+    param: click.Parameter,
+    value: str,
+):
+    source_id = value
+    elements = source_id.split(":", maxsplit=1)
+    if len(elements) != 2:
+        print(
+            "Data source must be in the format '{{class_id}}:{{argument}}' where class_id is one of:",
+            file=sys.stderr,
+        )
+        for id in DataSource.factory:
+            print(f"* {id}", file=sys.stderr)
+        ctx.exit(-1)
+    cls_id, target = elements
+    cls = DataSource.factory.get(cls_id)
+    if cls is None:
+        print(
+            f"Unknown data source class '{cls_id}', must be one of:",
+            file=sys.stderr,
+        )
+        for id in DataSource.factory:
+            print(f"* {id}", file=sys.stderr)
+        ctx.exit(-1)
+    return cls(target)
+
+
+def opt_data_source(function: Callable) -> Callable:
+    function = click.option(
+        "--data-source",
+        default="static-web:https://fossi-foundation.github.io/ciel-releases",
+        required=False,
+        show_default=True,
+        help="The data source to use for operations that may require contacting a remote server, in the format '{class_id}:{argument}'",
+        callback=data_source_cb,
+    )(function)
+    return function

{ciel-0.21.0.dev1 → ciel-1.0.0}/pyproject.toml

@@ -1,8 +1,11 @@
 [tool.poetry]
 name = "ciel"
-version = "0.21.0dev1"
+version = "1.0.0"
 description = "An PDK builder/version manager for PDKs in the open_pdks format"
-authors = ["Efabless Corporation and Contributors <donn@efabless.com>"]
+authors = [
+    "Mohamed Gaber <me@donn.website>",
+    "Efabless Corporation"
+]
 readme = "Readme.md"
 license = "Apache-2.0"
 repository = "https://github.com/fossi-foundation/ciel"