datasette-edit-schema 0.7.1__tar.gz → 0.8a5__tar.gz

{datasette-edit-schema-0.7.1/datasette_edit_schema.egg-info → datasette_edit_schema-0.8a5}/PKG-INFO

@@ -1,20 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: datasette-edit-schema
-Version: 0.7.1
+Version: 0.8a5
 Summary: Datasette plugin for modifying table schemas
-Home-page: https://github.com/simonw/datasette-edit-schema
 Author: Simon Willison
-License: Apache License, Version 2.0
-Requires-Python: >=3.7
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://datasette.io/plugins/datasette-edit-schema
+Project-URL: Changelog, https://github.com/simonw/datasette-edit-schema/releases
+Project-URL: Issues, https://github.com/simonw/datasette-edit-schema/issues
+Project-URL: CI, https://github.com/simonw/datasette-edit-schema/actions
+Classifier: Framework :: Datasette
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: datasette>=0.63
+Requires-Dist: datasette>=1.0a21
 Requires-Dist: sqlite-utils>=3.35
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: beautifulsoup4; extra == "test"
 Requires-Dist: html5lib; extra == "test"
+Dynamic: license-file
 
 # datasette-edit-schema
 
@@ -25,6 +30,8 @@ Requires-Dist: html5lib; extra == "test"
 
 Datasette plugin for modifying table schemas
 
+> :warning: The latest alpha release depends on Datasette 1.09a. Use [version 0.7.1](https://github.com/simonw/datasette-edit-schema/blob/0.7.1/README.md) with older releases of Datasette.
+
 ## Features
 
 * Add new columns to a table
@@ -54,13 +61,41 @@ By default only [the root actor](https://datasette.readthedocs.io/en/stable/auth
 
 ## Permissions
 
-The `edit-schema` permission governs access. You can use permission plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) to grant additional access to the write interface.
+This plugin registers an `edit-schema` action that applies to databases. Granting that action gives an actor access to every feature in the UI. Instances launched with `datasette --root` automatically allow the signed-in root actor to perform this action.
+
+All permission checks now call `datasette.allowed()` with `DatabaseResource` or `TableResource` objects, so they work seamlessly with Datasette’s `permission_resources_sql()` hook and configuration-based permission rules. Plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) can continue to be used to grant access to the write interface.
+
+For finer control you can combine Datasette’s built-in actions:
+
+- `create-table` allows users to create a new table (database-level resource).
+- `drop-table` allows users to drop a table (table-level resource).
+- `alter-table` allows users to alter a table (table-level resource).
+
+To rename a table a user must have both `drop-table` permission for that table and `create-table` permission for that database.
+
+For example, to configure Datasette to allow the user with ID `pelican` to create, alter and drop tables in the `marketing` database and to alter just the `notes` table in the `sales` database, you could use the following configuration:
+
+```yaml
+databases:
+  marketing:
+    permissions:
+      create-table:
+        id: pelican
+      drop-table:
+        id: pelican
+      alter-table:
+        id: pelican
+  sales:
+    tables:
+      notes:
+        permissions:
+          alter-table:
+            id: pelican
+```
 
-These permission checks will call the `permission_allowed()` plugin hook with three arguments:
+## Events
 
-- `action` will be the string `"edit-schema"`
-- `actor` will be the currently authenticated actor - usually a dictionary
-- `resource` will be the string name of the database
+This plugin fires `create-table`, `alter-table` and `drop-table` events when tables are modified, using the [Datasette Events](https://docs.datasette.io/en/latest/events.html) system introduced in [Datasette 1.0a8](https://docs.datasette.io/en/latest/changelog.html#a8-2024-02-07).
 
 ## Screenshot
 

datasette-edit-schema-0.7.1/PKG-INFO → datasette_edit_schema-0.8a5/README.md

@@ -1,21 +1,3 @@
-Metadata-Version: 2.1
-Name: datasette-edit-schema
-Version: 0.7.1
-Summary: Datasette plugin for modifying table schemas
-Home-page: https://github.com/simonw/datasette-edit-schema
-Author: Simon Willison
-License: Apache License, Version 2.0
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: datasette>=0.63
-Requires-Dist: sqlite-utils>=3.35
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-asyncio; extra == "test"
-Requires-Dist: beautifulsoup4; extra == "test"
-Requires-Dist: html5lib; extra == "test"
-
 # datasette-edit-schema
 
 [![PyPI](https://img.shields.io/pypi/v/datasette-edit-schema.svg)](https://pypi.org/project/datasette-edit-schema/)
@@ -25,6 +7,8 @@ Requires-Dist: html5lib; extra == "test"
 
 Datasette plugin for modifying table schemas
 
+> :warning: The latest alpha release depends on Datasette 1.09a. Use [version 0.7.1](https://github.com/simonw/datasette-edit-schema/blob/0.7.1/README.md) with older releases of Datasette.
+
 ## Features
 
 * Add new columns to a table
@@ -54,13 +38,41 @@ By default only [the root actor](https://datasette.readthedocs.io/en/stable/auth
 
 ## Permissions
 
-The `edit-schema` permission governs access. You can use permission plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) to grant additional access to the write interface.
+This plugin registers an `edit-schema` action that applies to databases. Granting that action gives an actor access to every feature in the UI. Instances launched with `datasette --root` automatically allow the signed-in root actor to perform this action.
+
+All permission checks now call `datasette.allowed()` with `DatabaseResource` or `TableResource` objects, so they work seamlessly with Datasette’s `permission_resources_sql()` hook and configuration-based permission rules. Plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) can continue to be used to grant access to the write interface.
+
+For finer control you can combine Datasette’s built-in actions:
+
+- `create-table` allows users to create a new table (database-level resource).
+- `drop-table` allows users to drop a table (table-level resource).
+- `alter-table` allows users to alter a table (table-level resource).
+
+To rename a table a user must have both `drop-table` permission for that table and `create-table` permission for that database.
+
+For example, to configure Datasette to allow the user with ID `pelican` to create, alter and drop tables in the `marketing` database and to alter just the `notes` table in the `sales` database, you could use the following configuration:
+
+```yaml
+databases:
+  marketing:
+    permissions:
+      create-table:
+        id: pelican
+      drop-table:
+        id: pelican
+      alter-table:
+        id: pelican
+  sales:
+    tables:
+      notes:
+        permissions:
+          alter-table:
+            id: pelican
+```
 
-These permission checks will call the `permission_allowed()` plugin hook with three arguments:
+## Events
 
-- `action` will be the string `"edit-schema"`
-- `actor` will be the currently authenticated actor - usually a dictionary
-- `resource` will be the string name of the database
+This plugin fires `create-table`, `alter-table` and `drop-table` events when tables are modified, using the [Datasette Events](https://docs.datasette.io/en/latest/events.html) system introduced in [Datasette 1.0a8](https://docs.datasette.io/en/latest/changelog.html#a8-2024-02-07).
 
 ## Screenshot