chipfoundry-cli 0.1.0__py3-none-any.whl

chipfoundry_cli/__init__.py

@@ -0,0 +1,2 @@
+"""ChipFoundry CLI package: Automate project submission to SFTP."""
+__version__ = "0.1.0" 

chipfoundry_cli/main.py

@@ -0,0 +1,173 @@
+import click
+import getpass
+from chipfoundry_cli.utils import (
+    collect_project_files, ensure_cf_directory, update_or_create_project_json,
+    sftp_connect, upload_with_progress, sftp_ensure_dirs
+)
+import os
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+
+DEFAULT_SSH_KEY = os.path.expanduser('~/.ssh/id_rsa')
+DEFAULT_SFTP_HOST = 'sftp.chipfoundry.io'
+
+GDS_TYPE_MAP = {
+    'user_project_wrapper.gds': 'digital',
+    'user_analog_project_wrapper.gds': 'analog',
+    'openframe_project_wrapper.gds': 'openframe',
+}
+
+console = Console()
+
+@click.group(help="ChipFoundry CLI: Automate project submission and management.")
+def main():
+    pass
+
+@main.command('submit')
+@click.option('--project-root', required=True, type=click.Path(exists=True, file_okay=False), help='Path to the local ChipFoundry project directory.')
+@click.option('--sftp-host', default=DEFAULT_SFTP_HOST, show_default=True, help='SFTP server hostname.')
+@click.option('--sftp-username', required=True, help='SFTP username.')
+@click.option('--sftp-key', type=click.Path(exists=True, dir_okay=False), help='Path to SFTP private key file. Defaults to ~/.ssh/id_rsa if it exists.', default=None, show_default=False)
+@click.option('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
+@click.option('--project-id', help='Project ID (e.g., "user123_proj456"). Overrides project.json if exists.')
+@click.option('--project-name', help='Project name (e.g., "my_project"). Overrides project.json if exists.')
+@click.option('--project-type', help='Project type (auto-detected if not provided).', default=None)
+@click.option('--force-overwrite', is_flag=True, help='Overwrite existing files on SFTP without prompting.')
+@click.option('--dry-run', is_flag=True, help='Preview actions without uploading files.')
+def submit(project_root, sftp_host, sftp_username, sftp_key, sftp_password, project_id, project_name, project_type, force_overwrite, dry_run):
+    """Submit a project to the SFTP server."""
+    # Determine which authentication method to use
+    key_path = sftp_key
+    password = sftp_password
+    # If neither provided, try default key
+    if not key_path and not password:
+        if os.path.exists(DEFAULT_SSH_KEY):
+            key_path = DEFAULT_SSH_KEY
+            console.print(f"[INFO] Using default SSH key: {DEFAULT_SSH_KEY}", style="bold cyan")
+        else:
+            console.print("[WARN] No SFTP key or password provided, and no default key found at ~/.ssh/id_rsa.", style="bold yellow")
+            auth_method = click.prompt("Choose authentication method (key/password)", type=click.Choice(['key', 'password']), show_choices=True)
+            if auth_method == 'key':
+                key_path = click.prompt("Enter path to SFTP private key", type=click.Path(exists=True, dir_okay=False))
+            else:
+                password = click.prompt("SFTP Password", hide_input=True)
+    elif key_path and password:
+        console.print("[ERROR] Options --sftp-password and --sftp-key are mutually exclusive.", style="bold red")
+        raise click.UsageError("Options --sftp-password and --sftp-key are mutually exclusive.")
+    elif not key_path and password:
+        pass  # password provided
+    elif key_path and not password:
+        if not os.path.exists(key_path):
+            console.print(f"[ERROR] SFTP key file not found: {key_path}", style="bold red")
+            raise click.UsageError(f"SFTP key file not found: {key_path}")
+
+    console.print(f"[INFO] Collecting project files from: {project_root}", style="bold cyan")
+    try:
+        collected = collect_project_files(project_root)
+        for rel_path, abs_path in collected.items():
+            if abs_path:
+                console.print(f"[OK] Found: {rel_path} -> {abs_path}", style="green")
+            else:
+                console.print(f"[INFO] Optional file not found: {rel_path}", style="yellow")
+    except FileNotFoundError as e:
+        console.print(f"[ERROR] {e}", style="bold red")
+        raise click.Abort()
+
+    # Auto-detect project type from GDS file name if not provided
+    gds_dir = Path(project_root) / 'gds'
+    found_types = []
+    gds_file_path = None
+    for gds_name, gds_type in GDS_TYPE_MAP.items():
+        candidate = gds_dir / gds_name
+        if candidate.exists():
+            found_types.append(gds_type)
+            gds_file_path = str(candidate)
+    if project_type:
+        detected_type = project_type
+    else:
+        if len(found_types) == 0:
+            console.print("[ERROR] No recognized GDS file found for project type detection.", style="bold red")
+            raise click.Abort()
+        elif len(found_types) > 1:
+            console.print(f"[ERROR] Multiple GDS types found: {found_types}. Only one project type is allowed per project.", style="bold red")
+            raise click.Abort()
+        else:
+            detected_type = found_types[0]
+            console.print(f"[INFO] Detected project type: {detected_type}", style="bold cyan")
+    # Use the detected GDS file for upload and hash
+    if gds_file_path:
+        collected['gds/user_project_wrapper.gds'] = gds_file_path
+    # Prepare CLI overrides for project.json
+    cli_overrides = {
+        "project_id": project_id,
+        "project_name": project_name,
+        "project_type": detected_type,
+        "sftp_username": sftp_username,
+    }
+    cf_dir = ensure_cf_directory(project_root)
+    console.print(f"[INFO] Generating/updating project.json in {cf_dir}", style="bold cyan")
+    project_json_path = update_or_create_project_json(
+        cf_dir=str(cf_dir),
+        gds_path=collected["gds/user_project_wrapper.gds"],
+        cli_overrides=cli_overrides,
+        existing_json_path=collected.get(".cf/project.json")
+    )
+    console.print(f"[OK] project.json ready: {project_json_path}", style="green")
+
+    # SFTP upload or dry-run
+    final_project_name = project_name or (
+        cli_overrides.get("project_name") or Path(project_root).name
+    )
+    sftp_base = f"incoming/projects/{final_project_name}"
+    upload_map = {
+        ".cf/project.json": project_json_path,
+        "gds/user_project_wrapper.gds": collected["gds/user_project_wrapper.gds"],
+        "verilog/rtl/user_defines.v": collected["verilog/rtl/user_defines.v"],
+    }
+    if dry_run:
+        console.print("[DRY-RUN] The following files would be uploaded:", style="bold magenta")
+        for rel_path, local_path in upload_map.items():
+            if local_path:
+                remote_path = os.path.join(sftp_base, rel_path)
+                console.print(f"  {local_path} -> {remote_path}", style="magenta")
+        console.print("[DRY-RUN] No files were uploaded.", style="bold magenta")
+        return
+
+    console.print(f"[INFO] Connecting to SFTP: {sftp_host} as {sftp_username}", style="bold cyan")
+    transport = None
+    try:
+        sftp, transport = sftp_connect(
+            host=sftp_host,
+            username=sftp_username,
+            password=password,
+            key_path=key_path
+        )
+        # Ensure the project directory exists before uploading
+        sftp_project_dir = f"incoming/projects/{final_project_name}"
+        sftp_ensure_dirs(sftp, sftp_project_dir)
+    except Exception as e:
+        console.print(f"[ERROR] Failed to connect to SFTP: {e}", style="bold red")
+        raise click.Abort()
+    try:
+        for rel_path, local_path in upload_map.items():
+            if local_path:
+                remote_path = os.path.join(sftp_base, rel_path)
+                upload_with_progress(
+                    sftp,
+                    local_path=local_path,
+                    remote_path=remote_path,
+                    force_overwrite=force_overwrite
+                )
+        console.print(f"[SUCCESS] All files uploaded to {sftp_base}", style="bold green")
+    except Exception as e:
+        console.print(f"[ERROR] SFTP upload failed: {e}", style="bold red")
+        raise click.Abort()
+    finally:
+        if transport:
+            sftp.close()
+            transport.close()
+
+if __name__ == "__main__":
+    main() 

chipfoundry_cli/utils.py

@@ -0,0 +1,180 @@
+import os
+import shutil
+from pathlib import Path
+from typing import Dict, Optional
+import json
+import hashlib
+import paramiko
+from rich.progress import Progress, BarColumn, TextColumn, TimeElapsedColumn, TaskProgressColumn
+
+REQUIRED_FILES = {
+    ".cf/project.json": False,  # Optional, may not exist
+    "gds/user_project_wrapper.gds": True,
+    "verilog/rtl/user_defines.v": True,
+}
+
+def collect_project_files(project_root: str) -> Dict[str, Optional[str]]:
+    """
+    Collect required project files from the given project_root.
+    Returns a dict mapping logical names to absolute file paths (or None if not found and optional).
+    Raises FileNotFoundError if any required file is missing.
+    """
+    project_root = Path(project_root)
+    collected = {}
+    for rel_path, required in REQUIRED_FILES.items():
+        abs_path = project_root / rel_path
+        if abs_path.exists():
+            collected[rel_path] = str(abs_path)
+        elif required:
+            raise FileNotFoundError(f"Required file not found: {abs_path}")
+        else:
+            collected[rel_path] = None
+    return collected
+
+def ensure_cf_directory(target_dir: str):
+    """
+    Ensure the .cf directory exists in the target directory.
+    """
+    cf_dir = Path(target_dir) / ".cf"
+    cf_dir.mkdir(parents=True, exist_ok=True)
+    return cf_dir
+
+def copy_files_to_temp(collected: Dict[str, Optional[str]], temp_dir: str):
+    """
+    Copy collected files to a temporary directory, preserving structure.
+    """
+    for rel_path, abs_path in collected.items():
+        if abs_path:
+            dest_path = Path(temp_dir) / rel_path
+            dest_path.parent.mkdir(parents=True, exist_ok=True)
+            shutil.copy2(abs_path, dest_path)
+
+def calculate_sha256(file_path: str) -> str:
+    """
+    Calculate SHA256 hash of the given file.
+    """
+    sha256 = hashlib.sha256()
+    with open(file_path, 'rb') as f:
+        for chunk in iter(lambda: f.read(8192), b''):
+            sha256.update(chunk)
+    return sha256.hexdigest()
+
+def load_project_json(json_path: str) -> dict:
+    """
+    Load project.json from the given path.
+    """
+    with open(json_path, 'r') as f:
+        return json.load(f)
+
+def save_project_json(json_path: str, data: dict):
+    """
+    Save the project.json to the given path (pretty-printed).
+    """
+    with open(json_path, 'w') as f:
+        json.dump(data, f, indent=2)
+
+def update_or_create_project_json(
+    cf_dir: str,
+    gds_path: str,
+    cli_overrides: dict,
+    existing_json_path: Optional[str] = None
+) -> str:
+    """
+    Update or create project.json in cf_dir. If existing_json_path is given, load and update it.
+    Otherwise, create a new one. Always update the user_project_wrapper_hash.
+    Returns the path to the updated/created project.json.
+    """
+    project_json_path = str(Path(cf_dir) / "project.json")
+    hash_val = calculate_sha256(gds_path)
+    if existing_json_path and Path(existing_json_path).exists():
+        data = load_project_json(existing_json_path)
+        if "project" not in data:
+            data["project"] = {}
+    else:
+        data = {"project": {}}
+    # Required fields with defaults
+    data["project"].setdefault("version", "1.0.0")
+    data["project"]["user_project_wrapper_hash"] = hash_val
+    # Apply CLI overrides
+    for key in ["id", "name", "type", "user", "version"]:
+        cli_key = f"project_{key}" if key != "user" else "sftp_username"
+        if cli_key in cli_overrides and cli_overrides[cli_key] is not None:
+            data["project"][key] = cli_overrides[cli_key]
+    save_project_json(project_json_path, data)
+    return project_json_path 
+
+def sftp_connect(host: str, username: str, password: str = None, key_path: str = None):
+    """
+    Establish an SFTP connection using paramiko. Returns an SFTP client.
+    """
+    transport = paramiko.Transport((host, 22))
+    if key_path:
+        private_key = paramiko.RSAKey.from_private_key_file(key_path)
+        transport.connect(username=username, pkey=private_key)
+    else:
+        transport.connect(username=username, password=password)
+    sftp = paramiko.SFTPClient.from_transport(transport)
+    return sftp, transport
+
+def sftp_ensure_dirs(sftp, remote_path: str):
+    """
+    Recursively create directories on the SFTP server if they do not exist.
+    """
+    dirs = []
+    path = remote_path
+    while len(path) > 1:
+        dirs.append(path)
+        path, _ = os.path.split(path)
+    dirs = dirs[::-1]
+    for d in dirs:
+        try:
+            sftp.stat(d)
+        except FileNotFoundError:
+            try:
+                sftp.mkdir(d)
+            except Exception:
+                pass
+
+def sftp_upload_file(sftp, local_path: str, remote_path: str, force_overwrite: bool = False, progress_cb=None):
+    """
+    Upload a file to the SFTP server, optionally overwriting. Optionally report progress via progress_cb(bytes_transferred, total_bytes).
+    """
+    try:
+        if not force_overwrite:
+            sftp.stat(remote_path)
+            print(f"[WARN] File exists on SFTP: {remote_path}. Skipping (use --force-overwrite to overwrite).")
+            return False
+    except FileNotFoundError:
+        pass  # File does not exist, proceed
+    sftp_ensure_dirs(sftp, os.path.dirname(remote_path))
+    if progress_cb:
+        file_size = os.path.getsize(local_path)
+        with open(local_path, 'rb') as f:
+            def callback(bytes_transferred, total=file_size):
+                progress_cb(bytes_transferred, total)
+            sftp.putfo(f, remote_path, callback=callback)
+    else:
+        sftp.put(local_path, remote_path)
+    print(f"[OK] Uploaded: {local_path} -> {remote_path}")
+    return True
+
+def upload_with_progress(sftp, local_path, remote_path, force_overwrite=False):
+    """
+    Upload a file with a rich progress bar.
+    """
+    file_size = os.path.getsize(local_path)
+    with Progress(
+        TextColumn("[progress.description]{task.description}"),
+        BarColumn(),
+        TaskProgressColumn(),
+        TextColumn("{task.percentage:>3.0f}%"),
+        TextColumn("•"),
+        TextColumn("{task.completed}/{task.total} bytes"),
+        TimeElapsedColumn(),
+    ) as progress:
+        task = progress.add_task(f"Uploading {os.path.basename(local_path)}", total=file_size)
+        def progress_cb(bytes_transferred, total):
+            progress.update(task, completed=bytes_transferred)
+        result = sftp_upload_file(sftp, local_path, remote_path, force_overwrite, progress_cb=progress_cb)
+        progress.update(task, completed=file_size)
+        return result 

chipfoundry_cli-0.1.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

chipfoundry_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,156 @@
+Metadata-Version: 2.1
+Name: chipfoundry-cli
+Version: 0.1.0
+Summary: CLI tool to automate ChipFoundry project submission to SFTP server
+Home-page: https://chipfoundry.io
+License: MIT
+Author: ChipFoundry
+Author-email: marwan.abbas@chipfoundry.io
+Requires-Python: >=3.8.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: click (>=8.0.0,<9)
+Requires-Dist: paramiko (>=3.0.0,<4)
+Requires-Dist: rich (>=12,<14)
+Project-URL: Repository, https://github.com/chipfoundry/cf-cli
+Description-Content-Type: text/markdown
+
+# ChipFoundry CLI (`cf-cli`)
+
+A command-line tool to automate the submission of ChipFoundry projects to the SFTP server.
+
+---
+
+## Overview
+
+`cf-cli` is a user-friendly command-line tool for securely submitting your ChipFoundry project files to the official SFTP server. It automatically collects the required files, generates or updates your project configuration, and uploads everything to the correct location on the server.
+
+---
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install cf-cli
+cf --help
+```
+
+---
+
+## Project Structure Requirements
+
+Your project directory **must** contain:
+
+- `gds/` directory with **one** of the following:
+  - `user_project_wrapper.gds` (for digital projects)
+  - `user_analog_project_wrapper.gds` (for analog projects)
+  - `openframe_project_wrapper.gds` (for openframe projects)
+- `verilog/rtl/user_defines.v` (required for digital/analog)
+- `.cf/project.json` (optional; will be created/updated automatically)
+
+**Example:**
+```
+my_project/
+├── gds/
+│   └── user_project_wrapper.gds
+├── verilog/
+│   └── rtl/
+│       └── user_defines.v
+└── .cf/
+    └── project.json
+```
+
+---
+
+## Authentication
+
+- By default, the tool will look for an SSH key at `~/.ssh/id_rsa`.
+- You can specify a different key with `--sftp-key`.
+- If no key is found, you will be prompted to enter a key path or your SFTP password.
+- Your SFTP username is required (provided by ChipFoundry).
+
+---
+
+## SFTP Server
+
+- The default SFTP server is `sftp.chipfoundry.io` (no need to specify unless you want to override).
+
+---
+
+## Usage
+
+### Basic Submission (Digital Project)
+
+```bash
+cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username>
+```
+
+### With a Custom SSH Key
+
+```bash
+cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-key /path/to/id_rsa
+```
+
+### With Password Authentication
+
+```bash
+cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-password <your_password>
+```
+
+### Dry Run (Preview what will be uploaded)
+
+```bash
+cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --dry-run
+```
+
+### Override Project Name or ID
+
+```bash
+cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --project-name my_custom_name --project-id my_custom_id
+```
+
+---
+
+## What Happens When You Run `cf submit`?
+
+1. **File Collection:**
+   - The tool checks for the required GDS and Verilog files.
+   - It auto-detects your project type (digital, analog, openframe) based on the GDS file name.
+2. **Configuration:**
+   - If `.cf/project.json` does not exist, it is created.
+   - The tool updates the GDS hash and any fields you override via CLI.
+3. **SFTP Upload:**
+   - Connects to the SFTP server as your user.
+   - Ensures the directory `incoming/projects/<project_name>` exists.
+   - Uploads `.cf/project.json`, the GDS file, and `verilog/rtl/user_defines.v` (if present).
+   - Shows a progress bar for each file upload.
+4. **Success:**
+   - You’ll see a green success message when all files are uploaded.
+
+---
+
+## Troubleshooting
+
+- **Missing files:**
+  - The tool will error out if required files are missing or if more than one GDS type is present.
+- **Authentication errors:**
+  - Make sure your SSH key is valid and registered with ChipFoundry, or use your password.
+- **SFTP errors:**
+  - Check your network connection and credentials.
+- **Project type detection:**
+  - Only one of the recognized GDS files should be present in your `gds/` directory.
+
+---
+
+## Support
+
+- For help, contact info@chipfoundry.io or visit [chipfoundry.io](https://chipfoundry.io)
+- For bug reports or feature requests, open an issue on [GitHub](https://github.com/chipfoundry/cf-cli)
+

chipfoundry_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+chipfoundry_cli/__init__.py,sha256=cYd16oPuk5XKAm2A4g07dAHBwj5DN2wO-PrKXSh6Gpo,90
+chipfoundry_cli/main.py,sha256=AgnJEsLm1CKcZBx81kJlkpsA-EA2V5fxGH6jjo53ya4,8115
+chipfoundry_cli/utils.py,sha256=vWYp7M54PAkqkws5ey_-rZ_8Ibq2JfPO3HN0dCOA2BM,6556
+chipfoundry_cli-0.1.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+chipfoundry_cli-0.1.0.dist-info/METADATA,sha256=FL9y-5JsotOdWldZ4ohh4SctkAbRelam2Yz5reBeUbM,4692
+chipfoundry_cli-0.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+chipfoundry_cli-0.1.0.dist-info/entry_points.txt,sha256=CTRdCwH9q4omjHCNP20NskVw-enR_ThAaPcBltNOFEU,57
+chipfoundry_cli-0.1.0.dist-info/RECORD,,

chipfoundry_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any

chipfoundry_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+chipfoundry=chipfoundry_cli.main:main
+