plain.dev 0.33.1__tar.gz → 0.33.2__tar.gz

{plain_dev-0.33.1 → plain_dev-0.33.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.33.1
-Summary: Local development tools for Plain.
+Version: 0.33.2
+Summary: A single command that runs everything you need for local development.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
 License-File: LICENSE
@@ -17,20 +17,41 @@ Description-Content-Type: text/markdown
 
 # plain.dev
 
-A single command that runs everything you need for local development.
+**A single command that runs everything you need for local development.**
 
 ![Plain dev command example](https://github.com/dropseed/plain/assets/649496/3643bb64-a99b-4a8e-adab-8c6b81791ea9)
 
-The `plain.dev` package can be [installed from PyPI](https://pypi.org/project/plain.dev/), and does _not_ need to be added to `INSTALLED_PACKAGES`.
+- [Overview](#overview)
+- [Commands](#commands)
+    - [`plain dev`](#plain-dev)
+        - [Services](#services)
+        - [Custom processes](#custom-processes)
+    - [`plain dev services`](#plain-dev-services)
+    - [`plain dev logs`](#plain-dev-logs)
+    - [`plain pre-commit`](#plain-pre-commit)
+- [VS Code debugging](#vs-code-debugging)
+- [Installation](#installation)
 
-- [`plain dev`](#plain-dev)
-- [`plain dev services`](#plain-dev-services)
-- [`plain dev logs`](#plain-dev-logs)
-- [`plain pre-commit`](#plain-pre-commit)
-- [`plain contrib`](#plain-contrib)
-- [VS Code debugging](#vscode-debugging)
+## Overview
 
-## `plain dev`
+The `plain.dev` package provides development tools for Plain applications. The main command, `plain dev`, starts everything you need for local development with a single command:
+
+```bash
+plain dev
+```
+
+This will:
+
+- Run preflight checks
+- Execute pending migrations
+- Start your development server with auto-reload
+- Build and watch CSS with Tailwind (if installed)
+- Start required services (like databases)
+- Run any custom processes you've defined
+
+## Commands
+
+### `plain dev`
 
 The `plain dev` command does several things:
 
@@ -43,7 +64,7 @@ The `plain dev` command does several things:
 - Any custom process defined in `pyproject.toml` at `tool.plain.dev.run`
 - Necessary services (ex. Postgres) defined in `pyproject.toml` at `tool.plain.dev.services`
 
-### Services
+#### Services
 
 Use services to define databases or other processes that your app _needs_ to be functional. The services will be started automatically in `plain dev`, but also in `plain pre-commit` (so preflight and tests have a database).
 
@@ -55,7 +76,7 @@ Ultimately, how you run your development database is up to you. But a recommende
 postgres = {cmd = "docker run --name app-postgres --rm -p 54321:5432 -v $(pwd)/.plain/dev/pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=postgres postgres:15 postgres"}
 ```
 
-### Custom processes
+#### Custom processes
 
 Unlike [services](#services), custom processes are _only_ run during `plain dev`. This is a good place to run something like [ngrok](https://ngrok.com/) or a [Plain worker](../../../plain-worker), which you might need to use your local site, but don't need running for executing tests, for example.
 
@@ -65,12 +86,12 @@ Unlike [services](#services), custom processes are _only_ run during `plain dev`
     ngrok = {command = "ngrok http $PORT"}
 ```
 
-## `plain dev services`
+### `plain dev services`
 
 Starts your [services](#services) by themselves.
 Logs are stored in `.plain/dev/logs/services/`.
 
-## `plain dev logs`
+### `plain dev logs`
 
 Show output from recent `plain dev` runs.
 
@@ -83,7 +104,7 @@ plain dev logs --pid 1234
 plain dev logs --path
 ```
 
-## `plain pre-commit`
+### `plain pre-commit`
 
 A built-in pre-commit hook that can be installed with `plain pre-commit --install`.
 
@@ -104,7 +125,7 @@ Runs:
 
 Since `plain dev` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers don't quite work.
 
-Instead, we include [microsoft/debugpy](https://github.com/microsoft/debugpy) and an `attach` function to make it even easier to use VS Code's debugger.
+Instead, we include [microsoft/debugpy](https://github.com/microsoft/debugpy) and provide debugging utilities to make it easier to use VS Code's debugger.
 
 First, import and run the `debug.attach()` function:
 
@@ -127,3 +148,13 @@ class HomeView(TemplateView):
 When you load the page, you'll see "Waiting for debugger to attach...".
 
 You can then run the VS Code debugger and attach to an existing Python process, at localhost:5678.
+
+## Installation
+
+Install the `plain.dev` package from [PyPI](https://pypi.org/project/plain.dev/):
+
+```bash
+uv add plain.dev --dev
+```
+
+Note: The `plain.dev` package does not need to be added to `INSTALLED_PACKAGES`.

{plain_dev-0.33.1 → plain_dev-0.33.2}/plain/dev/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain-dev changelog
 
+## [0.33.2](https://github.com/dropseed/plain/releases/plain-dev@0.33.2) (2025-08-22)
+
+### What's changed
+
+- The development localhost hostname is now automatically lowercased when generated from the pyproject.toml name ([4454f01](https://github.com/dropseed/plain/commit/4454f01787))
+- Updated README with improved structure, table of contents, and better installation instructions ([4ebecd1](https://github.com/dropseed/plain/commit/4ebecd1856))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.33.1](https://github.com/dropseed/plain/releases/plain-dev@0.33.1) (2025-07-18)
 
 ### What's changed

{plain_dev-0.33.1 → plain_dev-0.33.2}/plain/dev/README.md

@@ -1,19 +1,40 @@
 # plain.dev
 
-A single command that runs everything you need for local development.
+**A single command that runs everything you need for local development.**
 
 ![Plain dev command example](https://github.com/dropseed/plain/assets/649496/3643bb64-a99b-4a8e-adab-8c6b81791ea9)
 
-The `plain.dev` package can be [installed from PyPI](https://pypi.org/project/plain.dev/), and does _not_ need to be added to `INSTALLED_PACKAGES`.
+- [Overview](#overview)
+- [Commands](#commands)
+    - [`plain dev`](#plain-dev)
+        - [Services](#services)
+        - [Custom processes](#custom-processes)
+    - [`plain dev services`](#plain-dev-services)
+    - [`plain dev logs`](#plain-dev-logs)
+    - [`plain pre-commit`](#plain-pre-commit)
+- [VS Code debugging](#vs-code-debugging)
+- [Installation](#installation)
 
-- [`plain dev`](#plain-dev)
-- [`plain dev services`](#plain-dev-services)
-- [`plain dev logs`](#plain-dev-logs)
-- [`plain pre-commit`](#plain-pre-commit)
-- [`plain contrib`](#plain-contrib)
-- [VS Code debugging](#vscode-debugging)
+## Overview
 
-## `plain dev`
+The `plain.dev` package provides development tools for Plain applications. The main command, `plain dev`, starts everything you need for local development with a single command:
+
+```bash
+plain dev
+```
+
+This will:
+
+- Run preflight checks
+- Execute pending migrations
+- Start your development server with auto-reload
+- Build and watch CSS with Tailwind (if installed)
+- Start required services (like databases)
+- Run any custom processes you've defined
+
+## Commands
+
+### `plain dev`
 
 The `plain dev` command does several things:
 
@@ -26,7 +47,7 @@ The `plain dev` command does several things:
 - Any custom process defined in `pyproject.toml` at `tool.plain.dev.run`
 - Necessary services (ex. Postgres) defined in `pyproject.toml` at `tool.plain.dev.services`
 
-### Services
+#### Services
 
 Use services to define databases or other processes that your app _needs_ to be functional. The services will be started automatically in `plain dev`, but also in `plain pre-commit` (so preflight and tests have a database).
 
@@ -38,7 +59,7 @@ Ultimately, how you run your development database is up to you. But a recommende
 postgres = {cmd = "docker run --name app-postgres --rm -p 54321:5432 -v $(pwd)/.plain/dev/pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=postgres postgres:15 postgres"}
 ```
 
-### Custom processes
+#### Custom processes
 
 Unlike [services](#services), custom processes are _only_ run during `plain dev`. This is a good place to run something like [ngrok](https://ngrok.com/) or a [Plain worker](../../../plain-worker), which you might need to use your local site, but don't need running for executing tests, for example.
 
@@ -48,12 +69,12 @@ Unlike [services](#services), custom processes are _only_ run during `plain dev`
     ngrok = {command = "ngrok http $PORT"}
 ```
 
-## `plain dev services`
+### `plain dev services`
 
 Starts your [services](#services) by themselves.
 Logs are stored in `.plain/dev/logs/services/`.
 
-## `plain dev logs`
+### `plain dev logs`
 
 Show output from recent `plain dev` runs.
 
@@ -66,7 +87,7 @@ plain dev logs --pid 1234
 plain dev logs --path
 ```
 
-## `plain pre-commit`
+### `plain pre-commit`
 
 A built-in pre-commit hook that can be installed with `plain pre-commit --install`.
 
@@ -87,7 +108,7 @@ Runs:
 
 Since `plain dev` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers don't quite work.
 
-Instead, we include [microsoft/debugpy](https://github.com/microsoft/debugpy) and an `attach` function to make it even easier to use VS Code's debugger.
+Instead, we include [microsoft/debugpy](https://github.com/microsoft/debugpy) and provide debugging utilities to make it easier to use VS Code's debugger.
 
 First, import and run the `debug.attach()` function:
 
@@ -110,3 +131,13 @@ class HomeView(TemplateView):
 When you load the page, you'll see "Waiting for debugger to attach...".
 
 You can then run the VS Code debugger and attach to an existing Python process, at localhost:5678.
+
+## Installation
+
+Install the `plain.dev` package from [PyPI](https://pypi.org/project/plain.dev/):
+
+```bash
+uv add plain.dev --dev
+```
+
+Note: The `plain.dev` package does not need to be added to `INSTALLED_PACKAGES`.

{plain_dev-0.33.1 → plain_dev-0.33.2}/plain/dev/core.py

@@ -40,7 +40,7 @@ class DevProcess(ProcessManager):
                         "name", project_name
                     )
 
-            hostname = f"{project_name}.localhost"
+            hostname = f"{project_name.lower()}.localhost"
 
         self.hostname = hostname
         self.log_level = log_level

{plain_dev-0.33.1 → plain_dev-0.33.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "plain.dev"
-version = "0.33.1"
-description = "Local development tools for Plain."
+version = "0.33.2"
+description = "A single command that runs everything you need for local development."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"
 readme = "README.md"