ciel 0.21.0.dev0__py3-none-any.whl

ciel/__init__.py

@@ -0,0 +1,29 @@
+# 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.
+from .manage import (
+    VersionNotFound,
+    enable,
+    get,
+    fetch,
+)
+from .common import (
+    get_cielo_home,
+    Version,
+)
+from .families import Family
+from .github import (
+    GitHubSession,
+)
+from .build import build
+from .__version__ import __version__

ciel/__main__.py

@@ -0,0 +1,429 @@
+# 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 sys
+import json
+import httpx
+
+import click
+from rich.console import Console
+
+from .__version__ import __version__
+from .common import (
+    Version,
+    get_cielo_home,
+    resolve_version,
+)
+from .click_common import (
+    opt,
+    opt_build,
+    opt_push,
+    opt_pdk_root,
+    opt_token,
+)
+from .manage import (
+    print_installed_list,
+    print_remote_list,
+    enable,
+    fetch,
+)
+from .build import (
+    build_cmd,
+    push_cmd,
+)
+
+
+@click.command("output")
+@opt_pdk_root
+def output_cmd(pdk_root, pdk):
+    """Outputs the currently enabled PDK version.
+
+    If not outputting to a tty, the output is either the version string
+    unembellished, or, if no current version is enabled, an empty output with an
+    exit code of 1.
+    """
+
+    version = Version.get_current(pdk_root, pdk)
+    if sys.stdout.isatty():
+        if version is None:
+            print(f"No version of the PDK {pdk} is currently enabled at {pdk_root}.")
+            print(
+                "Invoke cielo --help for assistance installing and enabling versions."
+            )
+            exit(1)
+        else:
+            print(f"Installed: {pdk} v{version.name}")
+            print(
+                "Invoke cielo --help for assistance installing and enabling versions."
+            )
+    else:
+        if version is None:
+            exit(1)
+        else:
+            print(version.name, end="")
+
+
+@click.command("prune")
+@opt_pdk_root
+@click.option(
+    "--yes",
+    is_flag=True,
+    callback=lambda c, _, v: not v and c.abort(),
+    expose_value=False,
+    prompt="Are you sure? This will delete all non-enabled versions of the PDK from your computer.",
+)
+def prune_cmd(pdk_root, pdk):
+    """Removes all PDKs other than, if it exists, the one currently in use."""
+    pdk_versions = Version.get_all_installed(pdk_root, pdk)
+    for version in pdk_versions:
+        if version.is_current(pdk_root):
+            continue
+        try:
+            version.uninstall(pdk_root)
+            print(f"Deleted {version}.")
+        except Exception as e:
+            print(f"Failed to delete {version}: {e}", file=sys.stderr)
+
+
+@click.command("rm")
+@opt_pdk_root
+@click.option(
+    "--yes",
+    is_flag=True,
+    callback=lambda c, _, v: not v and c.abort(),
+    expose_value=False,
+    prompt="Are you sure? This will delete this version of the PDK from your computer.",
+)
+@click.argument("version", required=False)
+def rm_cmd(pdk_root, pdk, version):
+    """Removes the PDK version specified."""
+    version_object = Version(version, pdk)
+    try:
+        version_object.uninstall(pdk_root)
+        print(f"Deleted {version}.")
+    except Exception as e:
+        print(f"Failed to delete: {e}", file=sys.stderr)
+        exit(1)
+
+
+@click.command("ls")
+@opt_token
+@opt_pdk_root
+def list_cmd(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)
+
+    if sys.stdout.isatty():
+        console = Console()
+        print_installed_list(
+            pdk_root,
+            pdk,
+            console=console,
+            installed_list=pdk_versions,
+        )
+    else:
+        print(json.dumps([version.name for version in pdk_versions]), end="")
+
+
+@click.command("ls-remote")
+@opt_token
+@opt_pdk_root
+def list_remote_cmd(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 []
+
+        if sys.stdout.isatty():
+            console = Console()
+            print_remote_list(pdk_root, pdk, console, pdk_versions)
+        else:
+            for version in pdk_versions:
+                print(version.name)
+    except httpx.HTTPStatusError as e:
+        if sys.stdout.isatty():
+            console = Console()
+            console.print(f"[red]Encountered an error when polling version list: {e}")
+        else:
+            print(f"Failed to get version list: {e}", file=sys.stderr)
+        sys.exit(-1)
+    except httpx.NetworkError as e:
+        if sys.stdout.isatty():
+            console = Console()
+            console.print(
+                "[red]You don't appear to be connected to the Internet. ls-remote cannot be used."
+            )
+        else:
+            print(f"Failed to connect to remote server: {e}", file=sys.stderr)
+        sys.exit(-1)
+
+
+@click.command("path")
+@opt_pdk_root
+@click.argument("version", required=False)
+def path_cmd(pdk_root, pdk, version):
+    """
+    Prints the path of the cielo PDK root.
+
+    If a version is provided over the commandline, it prints the path to this
+    version instead.
+    """
+    if version is not None:
+        version = Version(version, pdk)
+        print(version.get_dir(pdk_root), end="")
+    else:
+        print(get_cielo_home(pdk_root))
+
+
+@click.command("enable")
+@opt_token
+@opt_pdk_root
+@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.option(
+    "-l",
+    "--include-libraries",
+    multiple=True,
+    default=None,
+    help="Libraries to include. You can use -l multiple times to include multiple libraries. Pass 'all' to include all of them. A default of 'None' uses a default set for the particular PDK.",
+)
+@click.argument("version", required=False)
+def enable_cmd(
+    pdk_root,
+    pdk,
+    tool_metadata_file_path,
+    version,
+    include_libraries,
+):
+    """
+    Activates a given installed PDK version.
+
+    Parameters: <version> (Optional)
+
+    If a version is not given, and you run this in the top level directory of
+    tools with a tool_metadata.yml file, for example OpenLane or DFFRAM,
+    the appropriate version will be enabled automatically.
+    """
+    if include_libraries == ():
+        include_libraries = None
+
+    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,
+            version,
+            include_libraries=include_libraries,
+            output=console,
+        )
+    except Exception as e:
+        console.print(f"[red]{e}")
+        exit(-1)
+
+
+@click.command("fetch")
+@opt_token
+@opt_pdk_root
+@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.option(
+    "-l",
+    "--include-libraries",
+    multiple=True,
+    default=None,
+    help="Libraries to include. You can use -l multiple times to include multiple libraries. Pass 'all' to include all of them. A default of 'None' uses a default set for the particular PDK.",
+)
+@click.argument("version", required=False)
+def fetch_cmd(
+    pdk_root,
+    pdk,
+    tool_metadata_file_path,
+    version,
+    include_libraries,
+):
+    """
+    Fetches a PDK to Cielo's store without setting it as the "enabled" version
+    in ``PDK_ROOT``.
+
+    Parameters: <version> (Optional)
+
+    If a version is not given, and you run this in the top level directory of
+    tools with a tool_metadata.yml file, for example OpenLane or DFFRAM,
+    the appropriate version will be enabled automatically.
+    """
+    if include_libraries == ():
+        include_libraries = None
+
+    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:
+        version = fetch(
+            pdk_root=pdk_root,
+            pdk=pdk,
+            version=version,
+            include_libraries=include_libraries,
+            output=console,
+        )
+        print(version.get_dir(pdk_root), end="")
+
+    except Exception as e:
+        console.print(f"[red]{e}")
+        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__,
+    message="""Cielo v%(version)s ©2022-2025 Efabless Corporation and Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this program 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.""",
+)
+def cli():
+    pass
+
+
+cli.add_command(output_cmd)
+cli.add_command(prune_cmd)
+cli.add_command(rm_cmd)
+cli.add_command(build_cmd)
+cli.add_command(push_cmd)
+cli.add_command(path_cmd)
+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
+except ModuleNotFoundError as e:
+    print(
+        f"Your version of Python 3 was not built with a required module: '{e.name}'",
+        file=sys.stderr,
+    )
+    print(
+        "Please install Python 3 with all (optional) dependencies using your operating system's package manager.",
+        file=sys.stderr,
+    )
+    print("This is a fatal error. Cielo will now quit.", file=sys.stderr)
+    exit(-1)
+
+
+if __name__ == "__main__":
+    cli()

ciel/__version__.py

@@ -0,0 +1,44 @@
+# Copyright 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 os
+import importlib.metadata
+import sys
+
+
+def __get_version():
+    try:
+        return importlib.metadata.version(__package__ or __name__)
+    except importlib.metadata.PackageNotFoundError:
+        import re
+
+        rx = re.compile(r"version\s*=\s*\"([^\"]+)\"")
+        repo_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        pyproject_path = os.path.join(repo_directory, "pyproject.toml")
+        try:
+            match = rx.search(open(pyproject_path, encoding="utf8").read())
+            assert match is not None, "pyproject.toml found, but without a version"
+            return match[1]
+        except FileNotFoundError:
+            print(
+                f"Warning: Failed to extract version for {__package__}.",
+                file=sys.stderr,
+            )
+            return "UNKNOWN"
+
+
+__version__ = __get_version()
+
+
+if __name__ == "__main__":
+    print(__version__, end="")