https://github.com/simonw/datasette-socrata

Import data from Socrata into Datasette
https://github.com/simonw/datasette-socrata

Last synced: 28 days ago
JSON representation

Import data from Socrata into Datasette

• Host: GitHub
• URL: https://github.com/simonw/datasette-socrata
• Owner: simonw
• License: apache-2.0
• Created: 2022-06-08T15:13:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-14T16:08:54.000Z (over 1 year ago)
• Last Synced: 2024-10-06T20:24:03.666Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datasette-socrata

[![PyPI](https://img.shields.io/pypi/v/datasette-socrata.svg)](https://pypi.org/project/datasette-socrata/)

[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-socrata?include_prereleases&label=changelog)](https://github.com/simonw/datasette-socrata/releases)

[![Tests](https://github.com/simonw/datasette-socrata/workflows/Test/badge.svg)](https://github.com/simonw/datasette-socrata/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-socrata/blob/main/LICENSE)

Import data from [Socrata](https://dev.socrata.com/) into [Datasette](https://datasette.io/)

## Installation

Install this plugin in the same environment as Datasette.

    datasette install datasette-socrata

## Usage

Make sure you have [enabled WAL mode](https://til.simonwillison.net/sqlite/enabling-wal-mode) on your database files before using this plugin.

Once installed, an interface for importing data from Socrata will become available at this URL:

    /-/import-socrata

Users will be able to paste in a URL to a dataset on Socrata in order to initialize an import.

You can also pre-fill the form by passing a `?url=` parameter, for example:

    /-/import-socrata?url=https://data.sfgov.org/City-Infrastructure/Street-Tree-List/tkzw-k3nq

Any database that is attached to Datasette, is NOT loaded as immutable (with the `-i` option) and that has WAL mode enabled will be available for users to import data into.

The `import-socrata` permission governs access. By default the `root` actor (accessible using `datasette --root` to start Datasette) is granted that permission.

You can use permission plugins such as [datasette-permissions-sql](https://github.com/simonw/datasette-permissions-sql) to grant additional access to other users.

## Configuration

If you only want Socrata imports to be allowed to a specific database, you can configure that using plugin configration in `metadata.yml`:

```yaml

plugins:

  datasette-socrata:

    database: socrata

```

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

    cd datasette-socrata

    python3 -m venv venv

    source venv/bin/activate

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest