From d01393d1bc552ad7af5fe33905ef718b92982ee2 Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Thu, 7 Sep 2023 20:54:07 -0700 Subject: [PATCH] Initial plugin, refs #1 --- .github/dependabot.yml | 10 + .github/workflows/publish.yml | 52 +++++ .github/workflows/test.yml | 28 +++ LICENSE | 201 ++++++++++++++++++ README.md | 36 ++++ datasette_debug_actors_from_ids.py | 22 ++ pyproject.toml | 26 +++ tests/test_datasette_debug_actors_from_ids.py | 34 +++ 8 files changed, 409 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/publish.yml create mode 100644 .github/workflows/test.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 datasette_debug_actors_from_ids.py create mode 100644 pyproject.toml create mode 100644 tests/test_datasette_debug_actors_from_ids.py diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..3760d92 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: +- package-ecosystem: pip + directory: "/" + schedule: + interval: daily + groups: + python-packages: + patterns: + - "*" diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..8a69106 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,52 @@ +name: Publish Python Package + +on: + release: + types: [created] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11"] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: setup.py + - name: Install dependencies + run: | + pip install '.[test]' + pip install https://github.com/simonw/datasette/archive/559f5390f6867ec6042aad395f24fc84fc48d10d.zip + - name: Run tests + run: | + pytest + deploy: + runs-on: ubuntu-latest + needs: [test] + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.11" + cache: pip + cache-dependency-path: setup.py + - name: Install dependencies + run: | + pip install setuptools wheel twine build + - name: Publish + env: + TWINE_USERNAME: __token__ + TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} + run: | + python -m build + twine upload dist/* + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..1d49604 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11"] + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: setup.py + - name: Install dependencies + run: | + pip install -e '.[test]' + pip install https://github.com/simonw/datasette/archive/559f5390f6867ec6042aad395f24fc84fc48d10d.zip + - name: Run tests + run: | + pytest diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..89554df --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# datasette-debug-actors-from-ids + +[![PyPI](https://img.shields.io/pypi/v/datasette-debug-actors-from-ids.svg)](https://pypi.org/project/datasette-debug-actors-from-ids/) +[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-debug-actors-from-ids?include_prereleases&label=changelog)](https://github.com/datasette/datasette-debug-actors-from-ids/releases) +[![Tests](https://github.com/datasette/datasette-debug-actors-from-ids/workflows/Test/badge.svg)](https://github.com/datasette/datasette-debug-actors-from-ids/actions?query=workflow%3ATest) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-debug-actors-from-ids/blob/main/LICENSE) + +A Datasette plugin for debugging the [new actors_from_ids plugin hook](https://github.com/simonw/datasette/issues/2180). + +## Installation + +```bash +datasette install datasette-debug-actors-from-ids +``` + +## Usage + +Adds a URL at `/-/debug-actors-from-ids`. Call it with `?ids=1,3,4` to exercise the plugin hook. + +## Development + +To set up this plugin locally, first checkout the code. Then create a new virtual environment: +```bash +cd datasette-debug-actors-from-ids +python3 -m venv venv +source venv/bin/activate +``` +Now install the dependencies and test dependencies: +``` +pip install -e '.[test]' +``` +``` +To run the tests: +```bash +pytest +``` diff --git a/datasette_debug_actors_from_ids.py b/datasette_debug_actors_from_ids.py new file mode 100644 index 0000000..69402f8 --- /dev/null +++ b/datasette_debug_actors_from_ids.py @@ -0,0 +1,22 @@ +from datasette import hookimpl, Response + + +async def debug_actors_from_ids(request, datasette): + # Must have view-instance permission + await datasette.ensure_permissions( + request.actor, + ["view-instance"], + ) + ids = (request.args.get("ids") or "").split(",") + if not ids: + return Response.html( + "

Must provide at least one actor ID

", + status=400, + ) + actors = await datasette.actors_from_ids(ids) + return Response.json(actors) + + +@hookimpl +def register_routes(): + return [(r"^/-/debug-actors-from-ids$", debug_actors_from_ids)] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..5206941 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,26 @@ +[project] +name = "datasette-debug-actors-from-ids" +version = "0.1a0" +description = "Datasette plugin for trying out the actors_from_ids hook" +readme = "README.md" +authors = [{name = "Simon Willison"}] +license = {text = "Apache-2.0"} +classifiers = [ + "License :: OSI Approved :: Apache Software License", + "Framework :: Datasette", +] +dependencies = [ + "datasette" +] + +[project.urls] +Homepage = "https://github.com/datasette/datasette-debug-actors-from-ids" +Changelog = "https://github.com/datasette/datasette-debug-actors-from-ids/releases" +Issues = "https://github.com/datasette/datasette-debug-actors-from-ids/issues" +CI = "https://github.com/datasette/datasette-debug-actors-from-ids/actions" + +[project.entry-points.datasette] +debug_actors_from_ids = "datasette_debug_actors_from_ids" + +[project.optional-dependencies] +test = ["pytest", "pytest-httpx", "pytest-asyncio"] \ No newline at end of file diff --git a/tests/test_datasette_debug_actors_from_ids.py b/tests/test_datasette_debug_actors_from_ids.py new file mode 100644 index 0000000..04103ca --- /dev/null +++ b/tests/test_datasette_debug_actors_from_ids.py @@ -0,0 +1,34 @@ +from datasette.app import Datasette +from datasette import hookimpl +from datasette.plugins import pm +import pytest + + +@pytest.mark.asyncio +async def test_debug_actors_from_ids(): + ds = Datasette() + await ds.invoke_startup() + + class ActorsFromIdsPlugin: + __name__ = "ActorsFromIdsPlugin" + + @hookimpl + def actors_from_ids(self, actor_ids): + return { + actor_id: { + "id": actor_id, + "name": "Name for {}".format(actor_id), + } + for actor_id in actor_ids + } + + try: + pm.register(ActorsFromIdsPlugin(), name="ActorsFromIdsPlugin") + response = await ds.client.get("/-/debug-actors-from-ids?ids=1,2") + assert response.status_code == 200 + assert response.json() == { + "1": {"id": "1", "name": "Name for 1"}, + "2": {"id": "2", "name": "Name for 2"}, + } + finally: + pm.unregister(name="ReturnNothingPlugin")