PyPI - chipfoundry-cli - Versions diffs - 0.1.1__tar.gz → 0.1.2__tar.gz - Mend

chipfoundry-cli 0.1.1tar.gz → 0.1.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

{chipfoundry_cli-0.1.1 → chipfoundry_cli-0.1.2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chipfoundry-cli
-Version: 0.1.1
+Version: 0.1.2
 Summary: CLI tool to automate ChipFoundry project submission to SFTP server
 Home-page: https://chipfoundry.io
 License: Apache-2.0
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: click (>=8.0.0,<9)
 Requires-Dist: paramiko (>=3.0.0,<4)
 Requires-Dist: rich (>=13,<14)
+Requires-Dist: toml (>=0.10,<1.0)
 Project-URL: Repository, https://github.com/chipfoundry/cf-cli
 Description-Content-Type: text/markdown
@@ -38,8 +39,8 @@ A command-line tool to automate the submission of ChipFoundry projects to the SF
 Install from PyPI:
 ```bash
-pip install cf-cli
-cf --help
+pip install chipfoundry-cli
+chipfoundry --help
 ```
 ---
@@ -86,39 +87,57 @@ my_project/
 ## Usage
-### Basic Submission (Digital Project)
+### Configure User Credentials
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username>
+chipfoundry config
 ```
+- Prompts for your SFTP username and key path. Only needs to be run once per user/machine.
-### With a Custom SSH Key
+### Initialize a New Project
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-key /path/to/id_rsa
+chipfoundry init
 ```
+- Prompts for project name, type (auto-detected from GDS file if present), and version.
+- Creates `.cf/project.json` in the current directory.
+- **Note:** The GDS hash is NOT generated at this step (see below).
-### With Password Authentication
+### Push a Project (Upload)
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-password <your_password>
+chipfoundry push
 ```
+- Run from your project directory (with `.cf/project.json`).
+- Collects files, updates the GDS hash, and uploads to SFTP.
-### Dry Run (Preview what will be uploaded)
+### Pull Results
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --dry-run
+chipfoundry pull
 ```
+- Downloads results for the current project to a local directory.
-### Override Project Name or ID
+### Check Status
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --project-name my_custom_name --project-id my_custom_id
+chipfoundry status
 ```
+- Shows all your projects and their input/output status on the SFTP server.
 ---
-## What Happens When You Run `cf submit`?
+## How the GDS Hash Works
+- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**.
+- The hash is calculated from the actual GDS file being uploaded.
+- This ensures the hash always matches the file you are submitting.
+- **You do not need to manage or update the hash manually.**
+- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission.
+---
+## What Happens When You Run `chipfoundry push`?
 1. **File Collection:**
    - The tool checks for the required GDS and Verilog files.
@@ -146,6 +165,8 @@ cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_u
   - Check your network connection and credentials.
 - **Project type detection:**
   - Only one of the recognized GDS files should be present in your `gds/` directory.
+- **ModuleNotFoundError: No module named 'toml':**
+  - This means your environment is missing the `toml` dependency. Upgrade `chipfoundry-cli` with `pip install --upgrade chipfoundry-cli`, or install `toml` manually with `pip install 'toml>=0.10,<1.0'`.
 ---

{chipfoundry_cli-0.1.1 → chipfoundry_cli-0.1.2}/README.md RENAMED Viewed

@@ -15,8 +15,8 @@ A command-line tool to automate the submission of ChipFoundry projects to the SF
 Install from PyPI:
 ```bash
-pip install cf-cli
-cf --help
+pip install chipfoundry-cli
+chipfoundry --help
 ```
 ---
@@ -63,39 +63,57 @@ my_project/
 ## Usage
-### Basic Submission (Digital Project)
+### Configure User Credentials
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username>
+chipfoundry config
 ```
+- Prompts for your SFTP username and key path. Only needs to be run once per user/machine.
-### With a Custom SSH Key
+### Initialize a New Project
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-key /path/to/id_rsa
+chipfoundry init
 ```
+- Prompts for project name, type (auto-detected from GDS file if present), and version.
+- Creates `.cf/project.json` in the current directory.
+- **Note:** The GDS hash is NOT generated at this step (see below).
-### With Password Authentication
+### Push a Project (Upload)
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --sftp-password <your_password>
+chipfoundry push
 ```
+- Run from your project directory (with `.cf/project.json`).
+- Collects files, updates the GDS hash, and uploads to SFTP.
-### Dry Run (Preview what will be uploaded)
+### Pull Results
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --dry-run
+chipfoundry pull
 ```
+- Downloads results for the current project to a local directory.
-### Override Project Name or ID
+### Check Status
 ```bash
-cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_username> --project-name my_custom_name --project-id my_custom_id
+chipfoundry status
 ```
+- Shows all your projects and their input/output status on the SFTP server.
 ---
-## What Happens When You Run `cf submit`?
+## How the GDS Hash Works
+- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**.
+- The hash is calculated from the actual GDS file being uploaded.
+- This ensures the hash always matches the file you are submitting.
+- **You do not need to manage or update the hash manually.**
+- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission.
+---
+## What Happens When You Run `chipfoundry push`?
 1. **File Collection:**
    - The tool checks for the required GDS and Verilog files.
@@ -123,6 +141,8 @@ cf submit --project-root /path/to/my_project --sftp-username <your_chipfoundry_u
   - Check your network connection and credentials.
 - **Project type detection:**
   - Only one of the recognized GDS files should be present in your `gds/` directory.
+- **ModuleNotFoundError: No module named 'toml':**
+  - This means your environment is missing the `toml` dependency. Upgrade `chipfoundry-cli` with `pip install --upgrade chipfoundry-cli`, or install `toml` manually with `pip install 'toml>=0.10,<1.0'`.
 ---

chipfoundry_cli-0.1.2/chipfoundry_cli/main.py ADDED Viewed

@@ -0,0 +1,454 @@
+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,
+    get_config_path, load_user_config, save_user_config
+)
+import os
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+import importlib.metadata
+from rich.table import Table
+from rich.progress import Progress, BarColumn, TextColumn, TimeElapsedColumn, TaskProgressColumn
+import json
+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()
+def get_project_json_from_cwd():
+    cf_path = Path(os.getcwd()) / '.cf' / 'project.json'
+    if cf_path.exists():
+        with open(cf_path) as f:
+            data = json.load(f)
+        project_name = data.get('project', {}).get('name')
+        return str(Path(os.getcwd())), project_name
+    return None, None
+@click.group(help="ChipFoundry CLI: Automate project submission and management.")
+@click.version_option(importlib.metadata.version("chipfoundry-cli"), "-v", "--version", message="%(version)s")
+def main():
+    pass
+@main.command('config')
+def config_cmd():
+    """Configure user-level SFTP credentials (username and key)."""
+    console.print("[bold cyan]ChipFoundry CLI User Configuration[/bold cyan]")
+    username = console.input("Enter your ChipFoundry SFTP username: ").strip()
+    key_path = console.input("Enter path to your SFTP private key (leave blank for ~/.ssh/id_rsa): ").strip()
+    if not key_path:
+        key_path = os.path.expanduser('~/.ssh/id_rsa')
+    config = {
+        "sftp_username": username,
+        "sftp_key": key_path,
+    }
+    save_user_config(config)
+    console.print(f"[green]Configuration saved to {get_config_path()}[/green]")
+@main.command('init')
+@click.option('--project-root', required=False, type=click.Path(file_okay=False), help='Directory to create the project in (defaults to current directory).')
+def init(project_root):
+    """Initialize a new ChipFoundry project (.cf/project.json) in the given directory."""
+    if not project_root:
+        project_root = os.getcwd()
+    cf_dir = Path(project_root) / '.cf'
+    cf_dir.mkdir(parents=True, exist_ok=True)
+    project_json_path = cf_dir / 'project.json'
+    if project_json_path.exists():
+        overwrite = console.input(f"[yellow]project.json already exists at {project_json_path}. Overwrite? (y/N): [/yellow]").strip().lower()
+        if overwrite != 'y':
+            console.print("[red]Aborted project initialization.[/red]")
+            return
+    # Get username from user config
+    config = load_user_config()
+    username = config.get("sftp_username")
+    if not username:
+        console.print("[bold red]No SFTP username found in user config. Please run 'chipfoundry config' first.[/bold red]")
+        raise click.Abort()
+    # Auto-detect project type from GDS file name
+    gds_dir = Path(project_root) / 'gds'
+    gds_type = None
+    gds_type_map = {
+        'user_project_wrapper.gds': 'digital',
+        'user_analog_project_wrapper.gds': 'analog',
+        'openframe_project_wrapper.gds': 'openframe',
+    }
+    for gds_name, gtype in gds_type_map.items():
+        if (gds_dir / gds_name).exists():
+            gds_type = gtype
+            break
+    name = console.input("Project name: ").strip()
+    # Suggest project type if detected
+    if gds_type:
+        project_type = console.input(f"Project type (digital/analog/openframe) [default: {gds_type}]: ").strip() or gds_type
+    else:
+        project_type = console.input("Project type (digital/analog/openframe): ").strip()
+    version = console.input("Version (default 1.0.0): ").strip() or "1.0.0"
+    # No hash yet, will be filled by push
+    data = {
+        "project": {
+            "name": name,
+            "type": project_type,
+            "user": username,
+            "version": version,
+            "user_project_wrapper_hash": ""
+        }
+    }
+    with open(project_json_path, 'w') as f:
+        json.dump(data, f, indent=2)
+    console.print(f"[green]Initialized project at {project_json_path}[/green]")
+@main.command('push')
+@click.option('--project-root', required=False, type=click.Path(exists=True, file_okay=False), help='Path to the local ChipFoundry project directory (defaults to current directory if .cf/project.json exists).')
+@click.option('--sftp-host', default=DEFAULT_SFTP_HOST, show_default=True, help='SFTP server hostname.')
+@click.option('--sftp-username', required=False, help='SFTP username (defaults to config).')
+@click.option('--sftp-key', type=click.Path(exists=True, dir_okay=False), help='Path to SFTP private key file (defaults to config).', 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 push(project_root, sftp_host, sftp_username, sftp_key, sftp_password, project_id, project_name, project_type, force_overwrite, dry_run):
+    """Upload your project files to the ChipFoundry SFTP server."""
+    # If .cf/project.json exists in cwd, use it as default project_root and project_name
+    cwd_root, cwd_project_name = get_project_json_from_cwd()
+    if not project_root and cwd_root:
+        project_root = cwd_root
+    if not project_name and cwd_project_name:
+        project_name = cwd_project_name
+    if not project_root:
+        console.print("[bold red]No project root specified and no .cf/project.json found in current directory. Please provide --project-root.[/bold red]")
+        raise click.Abort()
+    # Load user config for defaults
+    config = load_user_config()
+    if not sftp_username:
+        sftp_username = config.get("sftp_username")
+        if not sftp_username:
+            console.print("[bold red]No SFTP username provided and not found in config. Please run 'chipfoundry init' or provide --sftp-username.[/bold red]")
+            raise click.Abort()
+    if not sftp_key:
+        sftp_key = config.get("sftp_key")
+    # Determine which authentication method to use
+    key_path = sftp_key
+    password = sftp_password
+    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()
+@main.command('pull')
+@click.option('--project-name', required=False, help='Project name to pull results for (defaults to value in .cf/project.json if present).')
+@click.option('--output-dir', required=False, type=click.Path(file_okay=False), help='(Ignored) Local directory to save results (now always sftp-output/<project_name>).')
+@click.option('--sftp-host', default=DEFAULT_SFTP_HOST, show_default=True, help='SFTP server hostname.')
+@click.option('--sftp-username', required=False, help='SFTP username (defaults to config).')
+@click.option('--sftp-key', type=click.Path(exists=True, dir_okay=False), help='Path to SFTP private key file (defaults to config).', default=None, show_default=False)
+@click.option('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
+def pull(project_name, output_dir, sftp_host, sftp_username, sftp_key, sftp_password):
+    """Download results/artifacts from SFTP output dir to local sftp-output/<project_name>."""
+    # If .cf/project.json exists in cwd, use its project name as default
+    _, cwd_project_name = get_project_json_from_cwd()
+    if not project_name and cwd_project_name:
+        project_name = cwd_project_name
+    if not project_name:
+        console.print("[bold red]No project name specified and no .cf/project.json found in current directory. Please provide --project-name.[/bold red]")
+        raise click.Abort()
+    config = load_user_config()
+    if not sftp_username:
+        sftp_username = config.get("sftp_username")
+        if not sftp_username:
+            console.print("[bold red]No SFTP username provided and not found in config. Please run 'chipfoundry config' or provide --sftp-username.[/bold red]")
+            raise click.Abort()
+    if not sftp_key:
+        sftp_key = config.get("sftp_key")
+    key_path = sftp_key
+    password = sftp_password
+    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] 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
+        )
+    except Exception as e:
+        console.print(f"[ERROR] Failed to connect to SFTP: {e}", style="bold red")
+        raise click.Abort()
+    try:
+        remote_dir = f"outgoing/results/{project_name}"
+        output_dir = os.path.join(os.getcwd(), "sftp-output", project_name)
+        os.makedirs(output_dir, exist_ok=True)
+        try:
+            files = sftp.listdir(remote_dir)
+        except Exception:
+            console.print(f"[yellow]No results found for project '{project_name}' on SFTP server.[/yellow]")
+            return
+        if not files:
+            console.print(f"[yellow]No files to download for project '{project_name}'.[/yellow]")
+            return
+        with Progress(
+            TextColumn("[progress.description]{task.description}"),
+            BarColumn(),
+            TaskProgressColumn(),
+            TextColumn("{task.percentage:>3.0f}%"),
+            TextColumn("•"),
+            TextColumn("{task.completed}/{task.total} bytes"),
+            TimeElapsedColumn(),
+        ) as progress:
+            for fname in files:
+                remote_path = f"{remote_dir}/{fname}"
+                local_path = os.path.join(output_dir, fname)
+                try:
+                    file_size = sftp.stat(remote_path).st_size
+                    task = progress.add_task(f"Downloading {fname}", total=file_size)
+                    with open(local_path, "wb") as f:
+                        def callback(bytes_transferred, total=file_size):
+                            progress.update(task, completed=bytes_transferred)
+                        sftp.getfo(remote_path, f, callback=callback)
+                    progress.update(task, completed=file_size)
+                except Exception as e:
+                    console.print(f"[red]Failed to download {fname}: {e}[/red]")
+        console.print(f"[green]All files downloaded to {output_dir}[/green]")
+    finally:
+        if transport:
+            sftp.close()
+            transport.close()
+@main.command('status')
+@click.option('--sftp-host', default=DEFAULT_SFTP_HOST, show_default=True, help='SFTP server hostname.')
+@click.option('--sftp-username', required=False, help='SFTP username (defaults to config).')
+@click.option('--sftp-key', type=click.Path(exists=True, dir_okay=False), help='Path to SFTP private key file (defaults to config).', default=None, show_default=False)
+@click.option('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
+def status(sftp_host, sftp_username, sftp_key, sftp_password):
+    """Show all projects and outputs for the user on the SFTP server."""
+    config = load_user_config()
+    if not sftp_username:
+        sftp_username = config.get("sftp_username")
+        if not sftp_username:
+            console.print("[bold red]No SFTP username provided and not found in config. Please run 'chipfoundry init' or provide --sftp-username.[/bold red]")
+            raise click.Abort()
+    if not sftp_key:
+        sftp_key = config.get("sftp_key")
+    key_path = sftp_key
+    password = sftp_password
+    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] 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
+        )
+    except Exception as e:
+        console.print(f"[ERROR] Failed to connect to SFTP: {e}", style="bold red")
+        raise click.Abort()
+    try:
+        # List projects in incoming/projects/ and outgoing/results/
+        incoming_projects_dir = f"incoming/projects"
+        outgoing_results_dir = f"outgoing/results"
+        projects = []
+        results = []
+        try:
+            projects = sftp.listdir(incoming_projects_dir)
+        except Exception:
+            pass
+        try:
+            results = sftp.listdir(outgoing_results_dir)
+        except Exception:
+            pass
+        table = Table(title=f"SFTP Status for {sftp_username}")
+        table.add_column("Project Name", style="cyan", no_wrap=True)
+        table.add_column("Has Input", style="yellow")
+        table.add_column("Has Output", style="green")
+        all_projects = set(projects) | set(results)
+        for proj in sorted(all_projects):
+            has_input = "Yes" if proj in projects else "No"
+            has_output = "Yes" if proj in results else "No"
+            table.add_row(proj, has_input, has_output)
+        if all_projects:
+            console.print(table)
+        else:
+            console.print("[yellow]No projects or results found on SFTP server.[/yellow]")
+    finally:
+        if transport:
+            sftp.close()
+            transport.close()
+if __name__ == "__main__":
+    main()

{chipfoundry_cli-0.1.1 → chipfoundry_cli-0.1.2}/chipfoundry_cli/utils.py RENAMED Viewed

@@ -6,6 +6,7 @@ import json
 import hashlib
 import paramiko
 from rich.progress import Progress, BarColumn, TextColumn, TimeElapsedColumn, TaskProgressColumn
+import toml
 REQUIRED_FILES = {
     ".cf/project.json": False,  # Optional, may not exist
@@ -177,4 +178,19 @@ def upload_with_progress(sftp, local_path, remote_path, force_overwrite=False):
             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
+        return result
+def get_config_path() -> Path:
+    return Path.home() / ".chipfoundry-cli" / "config.toml"
+def load_user_config() -> dict:
+    config_path = get_config_path()
+    if config_path.exists():
+        return toml.load(config_path)
+    return {}
+def save_user_config(config: dict):
+    config_path = get_config_path()
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+    with open(config_path, 'w') as f:
+        toml.dump(config, f)

{chipfoundry_cli-0.1.1 → chipfoundry_cli-0.1.2}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "chipfoundry-cli"
-version = "0.1.1"
+version = "0.1.2"
 description = "CLI tool to automate ChipFoundry project submission to SFTP server"
 authors = ["ChipFoundry <marwan.abbas@chipfoundry.io>"]
 readme = "README.md"
@@ -14,6 +14,7 @@ python = ">=3.8.0"
 click = ">=8.0.0,<9"
 rich = ">=13,<14"
 paramiko = ">=3.0.0,<4"
+toml = ">=0.10,<1.0"
 [tool.poetry.dev-dependencies]
 wheel = "*"
@@ -22,6 +23,7 @@ flake8 = ">=4"
 [tool.poetry.scripts]
 chipfoundry = "chipfoundry_cli.main:main"
+cf = "chipfoundry_cli.main:main"
 [build-system]
 requires = ["poetry-core>=1.0.0"]

chipfoundry_cli-0.1.1/chipfoundry_cli/main.py DELETED Viewed

@@ -1,173 +0,0 @@
-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-0.1.1 → chipfoundry_cli-0.1.2}/LICENSE RENAMED Viewed

File without changes

{chipfoundry_cli-0.1.1 → chipfoundry_cli-0.1.2}/chipfoundry_cli/__init__.py RENAMED Viewed

File without changes

chipfoundry-cli 0.1.1__tar.gz → 0.1.2__tar.gz

chipfoundry-cli 0.1.1tar.gz → 0.1.2tar.gz