plain.start 0.1.0__tar.gz

plain_start-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+.venv
+/.env
+*.egg-info
+*.py[co]
+__pycache__
+*.DS_Store
+
+# Test apps
+plain*/tests/.plain
+
+# Agent scratch files
+/scratch
+
+# Plain temp dirs
+.plain
+
+.vscode
+/.claude
+/.benchmarks

plain_start-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Dropseed, LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

plain_start-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: plain.start
+Version: 0.1.0
+Summary: Bootstrap a new Plain project from starter templates
+Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: click>=8.0.0
+Description-Content-Type: text/markdown
+
+# Plain Start
+
+**Bootstrap a new Plain project from official starter templates.**
+
+- [Overview](#overview)
+- [Starter types](#starter-types)
+- [Options](#options)
+- [FAQs](#faqs)
+- [Installation](#installation)
+
+## Overview
+
+The `plain-start` command provides a streamlined way to create new Plain projects from official starter templates. It clones the starter repository, configures your project name, and optionally runs the installation script to get you up and running quickly.
+
+Basic usage:
+
+```bash
+uvx plain-start my-project
+```
+
+This creates a new project called `my-project` using the full app starter template (with ORM, auth, admin, etc.).
+
+## Starter types
+
+Plain provides two official starter templates:
+
+### App starter (default)
+
+The app starter includes a full-featured setup with:
+
+- Database ORM
+- Authentication system
+- Admin interface
+- Session management
+- All core Plain packages
+
+Create an app starter project:
+
+```bash
+uvx plain-start my-app
+# or explicitly:
+uvx plain-start my-app --type app
+```
+
+### Bare starter
+
+The bare starter is a minimal setup with:
+
+- Plain framework core
+- Development tools only
+- No database or auth by default
+
+Create a bare starter project:
+
+```bash
+uvx plain-start my-project --type bare
+```
+
+## Options
+
+The [`cli`](./cli.py#cli) command accepts the following options:
+
+### `--type`
+
+Choose between `app` (default) or `bare` starter templates.
+
+```bash
+uvx plain-start my-project --type bare
+```
+
+### `--no-install`
+
+Skip running the `./scripts/install` script after cloning. Useful if you want to review the project structure before installing dependencies.
+
+```bash
+uvx plain-start my-project --no-install
+```

plain_start-0.1.0/README.md

@@ -0,0 +1 @@
+plain/start/README.md

plain_start-0.1.0/plain/start/CHANGELOG.md

@@ -0,0 +1,11 @@
+# plain-start changelog
+
+## [0.1.0](https://github.com/dropseed/plain/releases/plain-start@0.1.0) (2025-11-17)
+
+### What's changed
+
+- First release
+
+### Upgrade instructions
+
+- No changes required

plain_start-0.1.0/plain/start/README.md

@@ -0,0 +1,77 @@
+# Plain Start
+
+**Bootstrap a new Plain project from official starter templates.**
+
+- [Overview](#overview)
+- [Starter types](#starter-types)
+- [Options](#options)
+- [FAQs](#faqs)
+- [Installation](#installation)
+
+## Overview
+
+The `plain-start` command provides a streamlined way to create new Plain projects from official starter templates. It clones the starter repository, configures your project name, and optionally runs the installation script to get you up and running quickly.
+
+Basic usage:
+
+```bash
+uvx plain-start my-project
+```
+
+This creates a new project called `my-project` using the full app starter template (with ORM, auth, admin, etc.).
+
+## Starter types
+
+Plain provides two official starter templates:
+
+### App starter (default)
+
+The app starter includes a full-featured setup with:
+
+- Database ORM
+- Authentication system
+- Admin interface
+- Session management
+- All core Plain packages
+
+Create an app starter project:
+
+```bash
+uvx plain-start my-app
+# or explicitly:
+uvx plain-start my-app --type app
+```
+
+### Bare starter
+
+The bare starter is a minimal setup with:
+
+- Plain framework core
+- Development tools only
+- No database or auth by default
+
+Create a bare starter project:
+
+```bash
+uvx plain-start my-project --type bare
+```
+
+## Options
+
+The [`cli`](./cli.py#cli) command accepts the following options:
+
+### `--type`
+
+Choose between `app` (default) or `bare` starter templates.
+
+```bash
+uvx plain-start my-project --type bare
+```
+
+### `--no-install`
+
+Skip running the `./scripts/install` script after cloning. Useful if you want to review the project structure before installing dependencies.
+
+```bash
+uvx plain-start my-project --no-install
+```

plain_start-0.1.0/plain/start/cli.py

@@ -0,0 +1,120 @@
+import re
+import shutil
+import subprocess
+from pathlib import Path
+
+import click
+
+STARTER_REPOS = {
+    "app": "https://github.com/dropseed/plain-starter-app",
+    "bare": "https://github.com/dropseed/plain-starter-bare",
+}
+
+
+@click.command()
+@click.argument("project_name")
+@click.option(
+    "--type",
+    "starter_type",
+    type=click.Choice(["app", "bare"]),
+    default="app",
+    help="Type of starter template to use",
+)
+@click.option(
+    "--no-install",
+    is_flag=True,
+    help="Skip running ./scripts/install after setup",
+)
+def cli(project_name: str, starter_type: str, no_install: bool) -> None:
+    """Bootstrap a new Plain project from starter templates"""
+    project_path = Path.cwd() / project_name
+
+    if project_path.exists():
+        click.secho(
+            f"Error: Directory '{project_name}' already exists", fg="red", err=True
+        )
+        raise click.Abort()
+
+    # Clone the starter repository
+    repo_url = STARTER_REPOS[starter_type]
+    click.secho(f"Cloning {starter_type} starter template...", dim=True)
+
+    try:
+        subprocess.run(
+            ["git", "clone", "--depth", "1", repo_url, project_name],
+            check=True,
+            capture_output=True,
+        )
+    except subprocess.CalledProcessError as e:
+        click.secho(
+            f"Error cloning repository: {e.stderr.decode()}", fg="red", err=True
+        )
+        raise click.Abort()
+
+    # Remove .git directory and reinitialize
+    click.secho("Initializing new git repository...", dim=True)
+    git_dir = project_path / ".git"
+    if git_dir.exists():
+        shutil.rmtree(git_dir)
+
+    subprocess.run(
+        ["git", "init"],
+        cwd=project_path,
+        check=True,
+        capture_output=True,
+    )
+
+    # Replace project name in pyproject.toml
+    click.secho("Configuring project...", dim=True)
+    pyproject_path = project_path / "pyproject.toml"
+
+    if pyproject_path.exists():
+        content = pyproject_path.read_text()
+        # Replace the name field in pyproject.toml
+        # Matches: name = "anything" or name = 'anything'
+        content = re.sub(
+            r'^name\s*=\s*["\'].*?["\']',
+            f'name = "{project_name}"',
+            content,
+            count=1,
+            flags=re.MULTILINE,
+        )
+        pyproject_path.write_text(content)
+
+    # Run install script unless --no-install
+    if not no_install:
+        install_script = project_path / "scripts" / "install"
+        if install_script.exists():
+            click.echo(
+                click.style("Running installation:", bold=True)
+                + click.style(" ./scripts/install", dim=True)
+            )
+            try:
+                subprocess.run(
+                    ["./scripts/install"],
+                    cwd=project_path,
+                    check=True,
+                )
+            except subprocess.CalledProcessError as e:
+                click.secho(
+                    f"Warning: Installation script failed with exit code {e.returncode}",
+                    fg="yellow",
+                    err=True,
+                )
+                click.secho(
+                    "You may need to run './scripts/install' manually.",
+                    fg="yellow",
+                    err=True,
+                )
+
+    # Success message
+    click.echo()
+    click.secho(
+        f"✓ Project '{project_name}' created successfully!", fg="green", bold=True
+    )
+    click.echo()
+    click.secho("Next steps:", bold=True)
+    click.secho(f"  cd {project_name}")
+    if no_install:
+        click.secho("  ./scripts/install")
+    click.secho("  uv run plain dev")

plain_start-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "plain.start"
+version = "0.1.0"
+description = "Bootstrap a new Plain project from starter templates"
+authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
+license = "BSD-3-Clause"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "click>=8.0.0",
+]
+
+[project.scripts]
+"plain-start" = "plain.start.cli:cli"
+
+[tool.hatch.build.targets.wheel]
+packages = ["plain"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"