datasette-public


Namedatasette-public JSON
Version 0.2.3 PyPI version JSON
download
home_pagehttps://github.com/simonw/datasette-public
SummaryMake specific Datasette tables visible to the public
upload_time2024-04-09 20:28:08
maintainerNone
docs_urlNone
authorSimon Willison
requires_python>=3.7
licenseApache License, Version 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # datasette-public

[![PyPI](https://img.shields.io/pypi/v/datasette-public.svg)](https://pypi.org/project/datasette-public/)
[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-public?include_prereleases&label=changelog)](https://github.com/simonw/datasette-public/releases)
[![Tests](https://github.com/simonw/datasette-public/workflows/Test/badge.svg)](https://github.com/simonw/datasette-public/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-public/blob/main/LICENSE)

Make specific Datasette tables visible to the public

## Installation

Install this plugin in the same environment as Datasette.

    datasette install datasette-public

## Usage

Any tables listed in the `_public_tables` table will be visible to the public, even if the rest of the Datasette instance does not allow anonymous access.

The root user (and any user with the new `public-tables` permission) will get a new option in the table action menu allowing them to toggle a table between public and private.

Installing this plugin also causes `allow-sql` permission checks to fall back to checking if the user has access to the entire database. This is to avoid users with access to a single public table being able to access data from other tables using the `?_where=` query string parameter.

## Configuration

This plugin creates a new table in one of your databases called `_public_tables`.

This table defaults to being created in the first database passed to Datasette.

To create it in a different named database, use this plugin configuration:

```json
{
  "plugins": {
    "datasette-public": {
      "database": "database_to_create_table_in"
    }
  }
}
```

## Development

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

    cd datasette-public
    python3 -m venv venv
    source venv/bin/activate

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simonw/datasette-public",
    "name": "datasette-public",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Simon Willison",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a2/da/0294a83be720bc8fb4d362d629055307a64edf5ac25365552019713f1358/datasette-public-0.2.3.tar.gz",
    "platform": null,
    "description": "# datasette-public\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-public.svg)](https://pypi.org/project/datasette-public/)\n[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-public?include_prereleases&label=changelog)](https://github.com/simonw/datasette-public/releases)\n[![Tests](https://github.com/simonw/datasette-public/workflows/Test/badge.svg)](https://github.com/simonw/datasette-public/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-public/blob/main/LICENSE)\n\nMake specific Datasette tables visible to the public\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n\n    datasette install datasette-public\n\n## Usage\n\nAny tables listed in the `_public_tables` table will be visible to the public, even if the rest of the Datasette instance does not allow anonymous access.\n\nThe root user (and any user with the new `public-tables` permission) will get a new option in the table action menu allowing them to toggle a table between public and private.\n\nInstalling this plugin also causes `allow-sql` permission checks to fall back to checking if the user has access to the entire database. This is to avoid users with access to a single public table being able to access data from other tables using the `?_where=` query string parameter.\n\n## Configuration\n\nThis plugin creates a new table in one of your databases called `_public_tables`.\n\nThis table defaults to being created in the first database passed to Datasette.\n\nTo create it in a different named database, use this plugin configuration:\n\n```json\n{\n  \"plugins\": {\n    \"datasette-public\": {\n      \"database\": \"database_to_create_table_in\"\n    }\n  }\n}\n```\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n\n    cd datasette-public\n    python3 -m venv venv\n    source venv/bin/activate\n\nNow install the dependencies and test dependencies:\n\n    pip install -e '.[test]'\n\nTo run the tests:\n\n    pytest\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Make specific Datasette tables visible to the public",
    "version": "0.2.3",
    "project_urls": {
        "CI": "https://github.com/simonw/datasette-public/actions",
        "Changelog": "https://github.com/simonw/datasette-public/releases",
        "Homepage": "https://github.com/simonw/datasette-public",
        "Issues": "https://github.com/simonw/datasette-public/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f65ac4c21bde6951d64f0ca06a8874f8d34e83abb8db86aad804c9cf9ca72ce9",
                "md5": "ad48eb8aac4e18e1376e49fddcd5d707",
                "sha256": "5a7c5b5612c7426b2dd25da56efdf42e96eb4e64e55dc7ea71944a30312648cc"
            },
            "downloads": -1,
            "filename": "datasette_public-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad48eb8aac4e18e1376e49fddcd5d707",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 8882,
            "upload_time": "2024-04-09T20:28:06",
            "upload_time_iso_8601": "2024-04-09T20:28:06.957926Z",
            "url": "https://files.pythonhosted.org/packages/f6/5a/c4c21bde6951d64f0ca06a8874f8d34e83abb8db86aad804c9cf9ca72ce9/datasette_public-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a2da0294a83be720bc8fb4d362d629055307a64edf5ac25365552019713f1358",
                "md5": "6fb901f6cdf6106a3ac576376ebc5d0c",
                "sha256": "8c138d82aeecc5f9107f75f118f16329d96e66ee733a1c2bb675185fa1442c89"
            },
            "downloads": -1,
            "filename": "datasette-public-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "6fb901f6cdf6106a3ac576376ebc5d0c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 9691,
            "upload_time": "2024-04-09T20:28:08",
            "upload_time_iso_8601": "2024-04-09T20:28:08.438623Z",
            "url": "https://files.pythonhosted.org/packages/a2/da/0294a83be720bc8fb4d362d629055307a64edf5ac25365552019713f1358/datasette-public-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-09 20:28:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonw",
    "github_project": "datasette-public",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datasette-public"
}
        
Elapsed time: 0.26237s