| Name | plain.dev JSON |
| Version |
0.33.3
JSON |
| download |
| home_page | None |
| Summary | A single command that runs everything you need for local development. |
| upload_time | 2025-09-03 21:40:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# plain.dev
**A single command that runs everything you need for local development.**
- [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)
## Overview
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:
- Sets `PLAIN_CSRF_TRUSTED_ORIGINS` to localhost by default
- Runs `plain preflight` to check for any issues
- Executes any pending model migrations
- Starts `gunicorn` with `--reload`
- Serves HTTPS on port 8443 by default (uses the next free port if 8443 is taken and no port is specified)
- Runs `plain tailwind build --watch`, if `plain.tailwind` is installed
- 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
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).
Ultimately, how you run your development database is up to you. But a recommended starting point is to use Docker:
```toml
# pyproject.toml
[tool.plain.dev.services]
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
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.
```toml
# pyproject.toml
[tool.plain.dev.run]
ngrok = {command = "ngrok http $PORT"}
```
### `plain dev services`
Starts your [services](#services) by themselves.
Logs are stored in `.plain/dev/logs/services/`.
### `plain dev logs`
Show output from recent `plain dev` runs.
Logs are stored in `.plain/dev/logs/run/`.
```bash
plain dev logs # print last log
plain dev logs -f # follow the latest log
plain dev logs --pid 1234
plain dev logs --path
```
### `plain pre-commit`
A built-in pre-commit hook that can be installed with `plain pre-commit --install`.
Runs:
- Custom commands defined in `pyproject.toml` at `tool.plain.pre-commit.run`
- `plain code check`, if [`plain.code`](https://plainframework.com/docs/plain-code/plain/code/) is installed
- `uv lock --locked`, if using uv
- `plain preflight --database default`
- `plain migrate --check`
- `plain makemigrations --dry-run --check`
- `plain build`
- `plain test`
## VS Code debugging
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 provide debugging utilities to make it easier to use VS Code's debugger.
First, import and run the `debug.attach()` function:
```python
class HomeView(TemplateView):
template_name = "home.html"
def get_template_context(self):
context = super().get_template_context()
# Make sure the debugger is attached (will need to be if runserver reloads)
from plain.dev import debug; debug.attach()
# Add a breakpoint (or use the gutter in VS Code to add one)
breakpoint()
return context
```
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`.
Raw data
{
"_id": null,
"home_page": null,
"name": "plain.dev",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Dave Gaeddert <dave.gaeddert@dropseed.dev>",
"download_url": "https://files.pythonhosted.org/packages/89/9c/56f2b0169bff41442362d466183449a8792e51f5dcee18309fdc79864d15/plain_dev-0.33.3.tar.gz",
"platform": null,
"description": "# plain.dev\n\n**A single command that runs everything you need for local development.**\n\n\n\n- [Overview](#overview)\n- [Commands](#commands)\n - [`plain dev`](#plain-dev)\n - [Services](#services)\n - [Custom processes](#custom-processes)\n - [`plain dev services`](#plain-dev-services)\n - [`plain dev logs`](#plain-dev-logs)\n - [`plain pre-commit`](#plain-pre-commit)\n- [VS Code debugging](#vs-code-debugging)\n- [Installation](#installation)\n\n## Overview\n\nThe `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:\n\n```bash\nplain dev\n```\n\nThis will:\n\n- Run preflight checks\n- Execute pending migrations\n- Start your development server with auto-reload\n- Build and watch CSS with Tailwind (if installed)\n- Start required services (like databases)\n- Run any custom processes you've defined\n\n## Commands\n\n### `plain dev`\n\nThe `plain dev` command does several things:\n\n- Sets `PLAIN_CSRF_TRUSTED_ORIGINS` to localhost by default\n- Runs `plain preflight` to check for any issues\n- Executes any pending model migrations\n- Starts `gunicorn` with `--reload`\n- Serves HTTPS on port 8443 by default (uses the next free port if 8443 is taken and no port is specified)\n- Runs `plain tailwind build --watch`, if `plain.tailwind` is installed\n- Any custom process defined in `pyproject.toml` at `tool.plain.dev.run`\n- Necessary services (ex. Postgres) defined in `pyproject.toml` at `tool.plain.dev.services`\n\n#### Services\n\nUse 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).\n\nUltimately, how you run your development database is up to you. But a recommended starting point is to use Docker:\n\n```toml\n# pyproject.toml\n[tool.plain.dev.services]\npostgres = {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\"}\n```\n\n#### Custom processes\n\nUnlike [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.\n\n```toml\n# pyproject.toml\n[tool.plain.dev.run]\n ngrok = {command = \"ngrok http $PORT\"}\n```\n\n### `plain dev services`\n\nStarts your [services](#services) by themselves.\nLogs are stored in `.plain/dev/logs/services/`.\n\n### `plain dev logs`\n\nShow output from recent `plain dev` runs.\n\nLogs are stored in `.plain/dev/logs/run/`.\n\n```bash\nplain dev logs # print last log\nplain dev logs -f # follow the latest log\nplain dev logs --pid 1234\nplain dev logs --path\n```\n\n### `plain pre-commit`\n\nA built-in pre-commit hook that can be installed with `plain pre-commit --install`.\n\nRuns:\n\n- Custom commands defined in `pyproject.toml` at `tool.plain.pre-commit.run`\n- `plain code check`, if [`plain.code`](https://plainframework.com/docs/plain-code/plain/code/) is installed\n- `uv lock --locked`, if using uv\n- `plain preflight --database default`\n- `plain migrate --check`\n- `plain makemigrations --dry-run --check`\n- `plain build`\n- `plain test`\n\n## VS Code debugging\n\n\n\nSince `plain dev` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers don't quite work.\n\nInstead, we include [microsoft/debugpy](https://github.com/microsoft/debugpy) and provide debugging utilities to make it easier to use VS Code's debugger.\n\nFirst, import and run the `debug.attach()` function:\n\n```python\nclass HomeView(TemplateView):\n template_name = \"home.html\"\n\n def get_template_context(self):\n context = super().get_template_context()\n\n # Make sure the debugger is attached (will need to be if runserver reloads)\n from plain.dev import debug; debug.attach()\n\n # Add a breakpoint (or use the gutter in VS Code to add one)\n breakpoint()\n\n return context\n```\n\nWhen you load the page, you'll see \"Waiting for debugger to attach...\".\n\nYou can then run the VS Code debugger and attach to an existing Python process, at localhost:5678.\n\n## Installation\n\nInstall the `plain.dev` package from [PyPI](https://pypi.org/project/plain.dev/):\n\n```bash\nuv add plain.dev --dev\n```\n\nNote: The `plain.dev` package does not need to be added to `INSTALLED_PACKAGES`.\n",
"bugtrack_url": null,
"license": null,
"summary": "A single command that runs everything you need for local development.",
"version": "0.33.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8773098ec6db8502b9145d67bcd9675be944abc0ed97f39ea6ce1f8eff48c5b7",
"md5": "bd282b10b7fd584f98ec0702444875c3",
"sha256": "a0b592639565e5ea115a8266e186e118b57670daa890e58ba2f11383606d0eb8"
},
"downloads": -1,
"filename": "plain_dev-0.33.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd282b10b7fd584f98ec0702444875c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 31707,
"upload_time": "2025-09-03T21:40:45",
"upload_time_iso_8601": "2025-09-03T21:40:45.461066Z",
"url": "https://files.pythonhosted.org/packages/87/73/098ec6db8502b9145d67bcd9675be944abc0ed97f39ea6ce1f8eff48c5b7/plain_dev-0.33.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "899c56f2b0169bff41442362d466183449a8792e51f5dcee18309fdc79864d15",
"md5": "483294835186fba6f4f7ea8b853e0761",
"sha256": "d15cb48581f8a63dbaf0c25b0fa6fca3800fdedbbf2418ac09db10a8eb7566cc"
},
"downloads": -1,
"filename": "plain_dev-0.33.3.tar.gz",
"has_sig": false,
"md5_digest": "483294835186fba6f4f7ea8b853e0761",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 23577,
"upload_time": "2025-09-03T21:40:46",
"upload_time_iso_8601": "2025-09-03T21:40:46.544036Z",
"url": "https://files.pythonhosted.org/packages/89/9c/56f2b0169bff41442362d466183449a8792e51f5dcee18309fdc79864d15/plain_dev-0.33.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 21:40:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "plain.dev"
}
