plain.dev 0.0.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

plain/dev/README.md

@@ -1,34 +1,34 @@
-# plain-dev
+# plain.dev
 
-A single command to run everything you need for local Plain development.
+A single command that runs everything you need for local development.
 
-![Plain work command example](https://user-images.githubusercontent.com/649496/176533533-cfd44dc5-afe5-42af-8b5d-33a9fa23f8d9.gif)
+![Plain dev command example](https://github.com/dropseed/plain/assets/649496/3643bb64-a99b-4a8e-adab-8c6b81791ea9)
 
-The `plain dev` command runs a combination of local commands + a Docker container for your database.
+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`.
 
-The following processes will run simultaneously (some will only run if they are detected as available):
+- [`plain dev`](#plain-dev)
+- [`plain dev services`](#plain-dev-services)
+- [`plain pre-commit`](#plain-pre-commit)
+- [`plain contrib`](#plain-contrib)
+- [VS Code debugging](#vscode-debugging)
 
-<!-- - [`manage.py runserver` (and migrations)](#runserver)
-- [`plain-models start --logs`](#plain-models)
-- [`plain-tailwind compile --watch`](#plain-tailwind)
-- [`npm run watch`](#package-json)
-- [`stripe listen --forward-to`](#stripe)
-- [`ngrok http --subdomain`](#ngrok)
+## `plain dev`
 
-It also comes with [debugging](#debugging) tools to make local debugging easier with VS Code. -->
+The `plain dev` command does several things:
 
-## Installation
+- 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`
+- Runs `plain tailwind compile --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`
 
-```sh
-pip install plain-dev
-```
+### Services
 
-If you have `plain-models` installed (i.e. you're using a database),
-then add `DATABASE_URL` to your `.env` file.
+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).
 
-```sh
-DATABASE_URL=postgres://postgres:postgres@localhost:54321/postgres
-```
+Ultimately, how you run your development database is up to you. But a recommended starting point is to use Docker:
 
 ```toml
 # pyproject.toml
@@ -36,59 +36,41 @@ DATABASE_URL=postgres://postgres:postgres@localhost:54321/postgres
 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"}
 ```
 
-```sh
-plain dev
-```
-
-## `plain dev`
-
-### Default processes
-
-- plain preflight
-- gunicorn
-- migrations
-- tailwind
-
 ### Custom processes
 
-- package.json "dev" script
-- pyproject.toml `tool.plain.dev.run = {command = "..."}`
-
-### GitHub Codespaces
-
-The `BASE_URL` setting is automatically set to the Codespace URL.
-
-TODO
-
-## `plain dev db`
-
-Only supports Postgres currently.
-
-- snapshot
-- import
-- export
+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"}
+```
 
-## Development processes
+## `plain dev services`
 
-### Gunicorn
+Starts your [services](#services) by themselves.
 
-The key process here is still `manage.py runserver`.
-But, before that runs, it will also wait for the database to be available and run `manage.py migrate`.
+## `plain pre-commit`
 
-### plain-models
+A built-in pre-commit hook that can be installed with `plain pre-commit --install`.
 
-If [`plain-models`](https://github.com/plainpackages/plain-models) is installed, it will automatically start and show the logs of the running database container.
+Runs:
 
-### plain-tailwind
+- 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
+- `poetry check --lock`, if using [Poetry](https://python-poetry.org/)
+- `plain preflight --database default`
+- `plain legacy migrate --check`
+- `plain legacy makemigrations --dry-run --check`
+- `plain compile`
+- `plain test`
 
-If [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind) is installed, it will automatically run the Tailwind `compile --watch` process.
+## VS Code debugging
 
-## Debugging
+![Debug Plain with VS Code](https://github.com/dropseed/plain-public/assets/649496/250138b6-7702-4ab6-bf38-e0c8e3c56d06)
 
-[View on YouTube →](https://www.youtube.com/watch?v=pG0KaJSVyBw)
+Since `plain dev` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers don't quite work.
 
-Since `plain work` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers can be hard to use.
 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.
 
 First, import and run the `debug.attach()` function:
@@ -97,13 +79,13 @@ First, import and run the `debug.attach()` function:
 class HomeView(TemplateView):
     template_name = "home.html"
 
-    def get_context(self, **kwargs):
-        context = super().get_context(**kwargs)
+    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.work import debug; debug.attach()
+        from plain.dev import debug; debug.attach()
 
-        # Add a breakpoint (or use the gutter in VSCode to add one)
+        # Add a breakpoint (or use the gutter in VS Code to add one)
         breakpoint()
 
         return context
@@ -111,38 +93,4 @@ class HomeView(TemplateView):
 
 When you load the page, you'll see "Waiting for debugger to attach...".
 
-Add a new VS Code debug configuration (using localhost and port 5768) by saving this to `.vscode/launch.json` or using the GUI:
-
-```json
-// .vscode/launch.json
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Plain: Attach to Django",
-            "type": "python",
-            "request": "attach",
-            "connect": {
-                "host": "localhost",
-                "port": 5678
-            },
-            "pathMappings": [
-                {
-                    "localRoot": "${workspaceFolder}",
-                    "remoteRoot": "."
-                }
-            ],
-            "justMyCode": true,
-            "django": true
-        }
-    ]
-}
-```
-
-Then in the "Run and Debug" tab, you can click the green arrow next to "Plain: Attach to Django" to start the debugger.
-
-In your terminal is should tell you it was attached, and when you hit a breakpoint you'll see the debugger information in VS Code.
-If Django's runserver reloads, you'll be prompted to reattach by clicking the green arrow again.
+You can then run the VS Code debugger and attach to an existing Python process, at localhost:5678.

plain/dev/precommit/cli.py

@@ -61,7 +61,7 @@ def cli(install):
             check_short("Running plain code checks", "plain", "code", "check")
 
         if Path("poetry.lock").exists():
-            check_short("Checking poetry.lock", "poetry", "lock", "--check")
+            check_short("Checking poetry.lock", "poetry", "check", "--lock")
 
         if plain_db_connected():
             check_short(

plain_dev-0.2.0.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: plain.dev
+Version: 0.2.0
+Summary: Local development tools for Plain.
+Home-page: https://plainframework.com
+License: BSD-3-Clause
+Author: Dave Gaeddert
+Author-email: dave.gaeddert@dropseed.dev
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.0.0)
+Requires-Dist: debugpy (>=1.6.3,<2.0.0)
+Requires-Dist: gunicorn (>20)
+Requires-Dist: honcho (>=1.1.0,<2.0.0)
+Requires-Dist: plain (<1.0.0)
+Requires-Dist: psycopg2-binary (>=2.9.3,<3.0.0)
+Requires-Dist: requests (>=2.0.0)
+Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
+Project-URL: Documentation, https://plainframework.com/docs/
+Project-URL: Repository, https://github.com/dropseed/plain
+Description-Content-Type: text/markdown
+
+<!-- This file is compiled from plain-dev/plain/dev/README.md. Do not edit this file directly. -->
+
+# plain.dev
+
+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`.
+
+- [`plain dev`](#plain-dev)
+- [`plain dev services`](#plain-dev-services)
+- [`plain pre-commit`](#plain-pre-commit)
+- [`plain contrib`](#plain-contrib)
+- [VS Code debugging](#vscode-debugging)
+
+## `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`
+- Runs `plain tailwind compile --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.
+
+## `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
+- `poetry check --lock`, if using [Poetry](https://python-poetry.org/)
+- `plain preflight --database default`
+- `plain legacy migrate --check`
+- `plain legacy makemigrations --dry-run --check`
+- `plain compile`
+- `plain test`
+
+## VS Code debugging
+
+![Debug Plain with VS Code](https://github.com/dropseed/plain-public/assets/649496/250138b6-7702-4ab6-bf38-e0c8e3c56d06)
+
+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.
+
+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.
+

{plain_dev-0.0.1.dist-info → plain_dev-0.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-plain/dev/README.md,sha256=WUuS441Nn0hiolb105wXPiip4l-WN_K_FU7bvwrPg58,4393
+plain/dev/README.md,sha256=XQEE75kBhUC3gf2GtMIfqCWYZ5E97xZnCZLuxTLiX-I,3713
 plain/dev/__init__.py,sha256=C1JrkNE5XX2DLgBXXLAV_UyhofwVd0ZPL59fPUMbOKo,139
 plain/dev/cli.py,sha256=hOQuAAGsMZ2tkFlDNfYl393Kn-QLhN4ruF1N5BZBzDQ,4859
 plain/dev/config.py,sha256=h6o5YZtJhg-cFIWoqIDWuMCC5T09cxEsBaa3BP4Nii0,632
@@ -11,15 +11,15 @@ plain/dev/debug.py,sha256=fIrecLfAK_lXSDyn3WmYikzZSse3KY47xcVVbZqJGhk,294
 plain/dev/default_settings.py,sha256=uXWYORWP_aRDwXIFXdu5kHyiBFUZzARIJdhPeFaX35c,75
 plain/dev/pid.py,sha256=gRMBf7aGndrra1TnmKtPghTijnd0i0Xeo63mzfPWp7M,436
 plain/dev/precommit/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
-plain/dev/precommit/cli.py,sha256=mvP5pxuVZdmOKXgDpJkoShx-28Py3XdS8jKKzsWLmrc,3554
+plain/dev/precommit/cli.py,sha256=5aesbLn5YqU0Y9SUVBsw9TWdhhFtNf9wYD3-g5kW9wQ,3554
 plain/dev/requests.py,sha256=0HyCH7iZ32ne94ypMdE96z5iYb_Qbd705WItVik1SyA,6839
 plain/dev/services.py,sha256=m4XOcY8qcUVA4u8vsFZmU-wChgQvy5uiu5abOR9wZfg,2127
 plain/dev/templates/dev/requests.html,sha256=kQKJZq5L77juuL_t8UjcAehEU61U4RXNnKaAET-wAm8,7627
 plain/dev/urls.py,sha256=b4NL2I6Ok-t7nTPjRnKoz_LQRttE3_mp8l2NlmeYQ9I,146
 plain/dev/utils.py,sha256=mL3C3l3GsKmtI6eF4sRjv7w9n7Y9lLVqJulj81JrqWw,312
 plain/dev/views.py,sha256=r2Ivk7OXytpRhXq4DZpsb7FXNP9vzmEE3D5kLajYG4w,1073
-plain_dev-0.0.1.dist-info/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
-plain_dev-0.0.1.dist-info/METADATA,sha256=qbY1kQqIOfSi-QC-VZn6ZDEIw7Tn14PoT0FCn8sZwHs,5536
-plain_dev-0.0.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-plain_dev-0.0.1.dist-info/entry_points.txt,sha256=rBo-S4THn07f55UwHBuUhIbDhlUq3EzTOD8mIb5fGQg,99
-plain_dev-0.0.1.dist-info/RECORD,,
+plain_dev-0.2.0.dist-info/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
+plain_dev-0.2.0.dist-info/METADATA,sha256=pmeDN3wYcbBguKpLR8PvqYFd1uTB-BQYXtiGvGTg9Us,4741
+plain_dev-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+plain_dev-0.2.0.dist-info/entry_points.txt,sha256=rBo-S4THn07f55UwHBuUhIbDhlUq3EzTOD8mIb5fGQg,99
+plain_dev-0.2.0.dist-info/RECORD,,

{plain_dev-0.0.1.dist-info → plain_dev-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.8.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

plain_dev-0.0.1.dist-info/METADATA

@@ -1,178 +0,0 @@
-Metadata-Version: 2.1
-Name: plain.dev
-Version: 0.0.1
-Summary: Work library for Plain
-Home-page: https://www.plainpackages.com/
-License: MIT
-Author: Dave Gaeddert
-Author-email: dave.gaeddert@dropseed.dev
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: click (>=8.0.0)
-Requires-Dist: debugpy (>=1.6.3,<2.0.0)
-Requires-Dist: gunicorn (>20)
-Requires-Dist: honcho (>=1.1.0,<2.0.0)
-Requires-Dist: psycopg2-binary (>=2.9.3,<3.0.0)
-Requires-Dist: requests (>=2.0.0)
-Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
-Project-URL: Documentation, https://www.plainpackages.com/docs/
-Project-URL: Repository, https://github.com/plainpackages/plain-dev
-Description-Content-Type: text/markdown
-
-<!-- This file is compiled from plain-dev/plain/dev/README.md. Do not edit this file directly. -->
-
-# plain-dev
-
-A single command to run everything you need for local Plain development.
-
-![Plain work command example](https://user-images.githubusercontent.com/649496/176533533-cfd44dc5-afe5-42af-8b5d-33a9fa23f8d9.gif)
-
-The `plain dev` command runs a combination of local commands + a Docker container for your database.
-
-The following processes will run simultaneously (some will only run if they are detected as available):
-
-<!-- - [`manage.py runserver` (and migrations)](#runserver)
-- [`plain-models start --logs`](#plain-models)
-- [`plain-tailwind compile --watch`](#plain-tailwind)
-- [`npm run watch`](#package-json)
-- [`stripe listen --forward-to`](#stripe)
-- [`ngrok http --subdomain`](#ngrok)
-
-It also comes with [debugging](#debugging) tools to make local debugging easier with VS Code. -->
-
-## Installation
-
-```sh
-pip install plain-dev
-```
-
-If you have `plain-models` installed (i.e. you're using a database),
-then add `DATABASE_URL` to your `.env` file.
-
-```sh
-DATABASE_URL=postgres://postgres:postgres@localhost:54321/postgres
-```
-
-```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"}
-```
-
-```sh
-plain dev
-```
-
-## `plain dev`
-
-### Default processes
-
-- plain preflight
-- gunicorn
-- migrations
-- tailwind
-
-### Custom processes
-
-- package.json "dev" script
-- pyproject.toml `tool.plain.dev.run = {command = "..."}`
-
-### GitHub Codespaces
-
-The `BASE_URL` setting is automatically set to the Codespace URL.
-
-TODO
-
-## `plain dev db`
-
-Only supports Postgres currently.
-
-- snapshot
-- import
-- export
-
-
-## Development processes
-
-### Gunicorn
-
-The key process here is still `manage.py runserver`.
-But, before that runs, it will also wait for the database to be available and run `manage.py migrate`.
-
-### plain-models
-
-If [`plain-models`](https://github.com/plainpackages/plain-models) is installed, it will automatically start and show the logs of the running database container.
-
-### plain-tailwind
-
-If [`plain-tailwind`](https://github.com/plainpackages/plain-tailwind) is installed, it will automatically run the Tailwind `compile --watch` process.
-
-## Debugging
-
-[View on YouTube →](https://www.youtube.com/watch?v=pG0KaJSVyBw)
-
-Since `plain work` runs multiple processes at once, the regular [pdb](https://docs.python.org/3/library/pdb.html) debuggers can be hard to use.
-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.
-
-First, import and run the `debug.attach()` function:
-
-```python
-class HomeView(TemplateView):
-    template_name = "home.html"
-
-    def get_context(self, **kwargs):
-        context = super().get_context(**kwargs)
-
-        # Make sure the debugger is attached (will need to be if runserver reloads)
-        from plain.work import debug; debug.attach()
-
-        # Add a breakpoint (or use the gutter in VSCode to add one)
-        breakpoint()
-
-        return context
-```
-
-When you load the page, you'll see "Waiting for debugger to attach...".
-
-Add a new VS Code debug configuration (using localhost and port 5768) by saving this to `.vscode/launch.json` or using the GUI:
-
-```json
-// .vscode/launch.json
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Plain: Attach to Django",
-            "type": "python",
-            "request": "attach",
-            "connect": {
-                "host": "localhost",
-                "port": 5678
-            },
-            "pathMappings": [
-                {
-                    "localRoot": "${workspaceFolder}",
-                    "remoteRoot": "."
-                }
-            ],
-            "justMyCode": true,
-            "django": true
-        }
-    ]
-}
-```
-
-Then in the "Run and Debug" tab, you can click the green arrow next to "Plain: Attach to Django" to start the debugger.
-
-In your terminal is should tell you it was attached, and when you hit a breakpoint you'll see the debugger information in VS Code.
-If Django's runserver reloads, you'll be prompted to reattach by clicking the green arrow again.
-