datasette-app-support

https://github.com/simonw/datasette-app 的组成部分

安装

在Datasette相同的环境中安装此插件。

$ datasette install datasette-app-support

在Datasette.app的上下文之外使用此插件可能不会工作。

API端点

此插件公开了由Electron包装器调用的API。

所有插件都受到身份验证的保护：需要使用带有Authorization: Bearer xxx令牌调用它们，其中xxx与DATASETTE_API_TOKEN环境变量的值匹配。

/-/auth-app-user

POST /-/auth-app-user
{"redirect": "/-/metadata"}

如果传递了有效的Authorization头，则设置一个签名cookie，标识用户为{"id": "admin"}并将他们重定向到指定的页面。

/-/open-database-file

POST /-/open-database-file
{"path": "/path/to/file.db"}

将新的数据库文件附加到正在运行的Datasette实例 - 由“打开数据库...”菜单选项使用。

如果工作正常，则返回HTTP 200状态和{"ok": True, "path": "/file"}，如果失败，则返回400和带有"error" JSON字符串消息的400或500。

/-/new-empty-database-file

POST /-/new-empty-database-file
{"path": "/path/to/file.db"}

在指定的路径创建一个新的空SQLite数据库文件并将其附加到Datasette实例。由“创建空数据库...”菜单选项使用。

如果工作正常，则返回HTTP 200状态和{"ok": True, "path": "/file"}，如果失败，则返回400和带有"error" JSON字符串消息的400或500。

/-/open-csv-file

POST /-/open-csv-file
{"path": "/path/to/file.csv"}

将CSV或TSV文件导入默认的/temporary内存数据库。由“打开CSV...”菜单选项使用。

如果工作正常，则返回HTTP 200状态和{"ok": True, "path": "/temporary/table"}，如果失败，则返回400或500和带有"error" JSON字符串消息。

/-/import-csv-file

POST /-/import-csv-file
{"path": "/path/to/file.csv", "database": "database_name"}

永久将CSV或TSV文件导入指定的数据库。由“导入CSV...”菜单选项使用。

如果操作成功，返回HTTP 200状态码以及{"ok": True, "path": "/database_name/table"}，如果失败，返回400或500状态码以及包含错误信息的"error" JSON字符串。

/-/open-csv-from-url

POST /-/open-csv-from-url
{"url": "https://example.com/file.csv", "table_name": "My_suggested_table_name"}

将CSV文件导入默认的/temporary内存数据库中。用于“从URL打开CSV...”菜单选项。table_name是可选的 - 如果省略，将使用URL来推导名称。

如果工作正常，则返回HTTP 200状态和{"ok": True, "path": "/temporary/table"}，如果失败，则返回400或500和带有"error" JSON字符串消息。

/-/dump-temporary-to-file

POST /-/dump-temporary-to-file
{"path": "/path/to/backup.db"}

将temporary内存数据库的内容导出到指定的文件。这通常用于在安装插件后重启Datasette服务器时的临时备份，请参阅datasette-app/issues/42。

如果操作成功，返回HTTP 200状态码以及{"ok": True, "path": "/path/to/backup.db"}，如果失败，返回400或500状态码以及包含错误信息的"error" JSON字符串。

/-/restore-temporary-to-file

POST /-/restore-temporary-from-file
{"path": "/path/to/backup.db"}

将temporary内存数据库恢复到指定文件的内容。

如果操作成功，返回HTTP 200状态码以及{"ok": True, "path": "/path/to/backup.db"}，如果失败，返回400或500状态码以及包含错误信息的"error" JSON字符串。

开发

要在本地设置此插件，首先检出代码。然后创建一个新的虚拟环境

cd datasette-app-support
python3 -mvenv venv
source venv/bin/activate

或者如果您使用pipenv

pipenv shell

现在安装依赖项和测试依赖项

pip install -e '.[test]'

运行测试

pytest