Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datasette/datasette-extract
Import unstructured data (text and images) into structured tables
https://github.com/datasette/datasette-extract
Last synced: 4 days ago
JSON representation
Import unstructured data (text and images) into structured tables
- Host: GitHub
- URL: https://github.com/datasette/datasette-extract
- Owner: datasette
- License: apache-2.0
- Created: 2023-08-15T19:57:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T19:21:28.000Z (5 months ago)
- Last Synced: 2024-12-25T06:09:12.707Z (11 days ago)
- Language: JavaScript
- Homepage:
- Size: 823 KB
- Stars: 145
- Watchers: 3
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# datasette-extract
[](https://pypi.org/project/datasette-extract/)
[](https://github.com/datasette/datasette-extract/releases)
[](https://github.com/datasette/datasette-extract/actions?query=workflow%3ATest)
[](https://github.com/datasette/datasette-extract/blob/main/LICENSE)
Import unstructured data (text and images) into structured tables
## Installation
Install this plugin in the same environment as [Datasette](https://datasette.io/).
```bash
datasette install datasette-extract
```
## Configuration
This plugin requires an [OpenAI API key](https://platform.openai.com/api-keys).
You can set this using the `DATASETTE_SECRETS_OPENAI_API_KEY` environment variable, or you can configure the [datasette-secrets](https://github.com/datasette/datasette-secrets) plugin to allow users to enter their own plugin and save it, encrypted, in their database.
Here's how to start using this plugin with that environment variable:
```bash
DATASETTE_SECRETS_OPENAI_API_KEY="xxx" datasette data.db --root --create
# Now click or command-click the URL containing .../-/auth-token?token=...
```
- Replace `xxx` with your OpenAI API key
- The `--root` flag causes Datasette to output a link that will sign you in as root
- The `--create` flag will create the `data.db` SQLite database file if it does not exist
## Usage
This plugin provides the following features:
- In the database action cog menu for a database select "Create table with extracted data" to create a new table with data extracted from text or an image
- In the table action cog menu select "Extract data into this table" to extract data into an existing table
When creating a table you can specify the column names, types and provide an optional hint (like "YYYY-MM-DD" for dates) to influence how the data should be extracted.
When populating an existing table you can provide hints and select which columns should be populated.
Text input can be pasted directly into the textarea.
Drag and drop a PDF or text file onto the textarea to populate it with the contents of that file. PDF files will have their text extracted, but only if the file contains text as opposed to scanned images.
Drag and drop a single image onto the textarea - or select it with the image file input box - to process an image.
## Permissions
Users must have the `datasette-extract` permission to use this tool.
In order to create tables they also need the `create-table` permission.
To insert rows into an existing table they need `insert-row`.
## Development
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd datasette-extract
python3 -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```