Metadata-Version: 2.4
Name: cwapi3d-starter
Version: 0.2.0
Summary: Project scaffolding for cwapi3d Python projects
Project-URL: Homepage, https://github.com/Brunner246/cwapi3d-starter
Project-URL: Repository, https://github.com/Brunner246/cwapi3d-starter
Project-URL: Issues, https://github.com/Brunner246/cwapi3d-starter/issues
Author-email: Michael Brunner <brunner@cadwork.swiss>
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Code Generators
Requires-Python: >=3.12
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.0
Description-Content-Type: text/markdown

# cwapi3d-starter

Project scaffolding CLI for cwapi3d users.

## Prerequisites

- [uv](https://github.com/astral-sh/uv) installed.
- Python 3.12+

## Installation

### Global Installation (User)

You can install the tool globally to use it anywhere on your system.

**Using uv (Recommended):**
```bash
# Run from the project root
uv tool install .
```

or from PyPI:
```bash
uv tool install cwapi3d-starter
```

**Using pip:**
```bash
# Run from the project root
pip install .
```

### From Source (Development)

1. **Clone the repository:**
   ```bash
   git clone https://github.com/Brunner246/cwapi3d-starter.git
   cd cwapi3d-starter
   ```

2. **Install dependencies:**
   ```bash
   uv sync
   ```

## Usage

### If installed globally

Once installed, you can run the `cwapi3d-starter` command directly from anywhere:

```bash
cwapi3d-starter <project_name> --directory <target_directory>
```

### If running from source

To generate a new project using the CLI from the source:

```bash
uv run cwapi3d-starter <project_name> --directory <target_directory>
```
Or simply:
```bash
uv run cwapi3d-starter <project_name> # Directory defaults to <project_name> in current folder
```

### Example

```bash
# Generate a project named "my_script" in the specified directory
# Note: name and directory name need to be the same name for the generated project to work correctly.
uv run cwapi3d-starter my_script --directory "D:\cadwork\userprofil_2026\3d\API.x64\my_script"
```

This will generate a ready-to-use project structure for developing Python scripts using the `cwapi3d` Python stubs for cadwork 3d, including:
- Virtual environment setup (`uv`)
- VS Code configuration (`settings.json`)
- Sample code (`main.py`, `example_geometry.py`)
- Python package structure
