datasette-mask-columns


Namedatasette-mask-columns JSON
Version 0.2.2 PyPI version JSON
download
home_pagehttps://github.com/simonw/datasette-mask-columns
SummaryDatasette plugin that masks specified database columns
upload_time2023-09-20 02:18:50
maintainer
docs_urlNone
authorSimon Willison
requires_python
licenseApache License, Version 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # datasette-mask-columns

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

Datasette plugin that masks specified database columns

## Installation

    pip install datasette-mask-columns

This depends on plugin hook changes in a not-yet released branch of Datasette. See [issue #678](https://github.com/simonw/datasette/issues/678) for details.

## Usage

In your `metadata.json` file add a section like this describing the database and table in which you wish to mask columns:

```json
{
    "databases": {
        "my-database": {
            "plugins": {
                "datasette-mask-columns": {
                    "users": ["password"]
                }
            }
        }
    }
}
```
All SQL queries against the `users` table in `my-database.db` will now return `null` for the `password` column, no matter what value that column actually holds.

The table page for `users` will display the text `REDACTED` in the masked column. This visual hint will only be available on the table page; it will not display his text for arbitrary queries against the table.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simonw/datasette-mask-columns",
    "name": "datasette-mask-columns",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Simon Willison",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e3/43/2df25a9584e6f68d4cf72e5963101a48c6cc8dcf7d516f8f0170ef5e511c/datasette-mask-columns-0.2.2.tar.gz",
    "platform": null,
    "description": "# datasette-mask-columns\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-mask-columns.svg)](https://pypi.org/project/datasette-mask-columns/)\n[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-mask-columns?include_prereleases&label=changelog)](https://github.com/simonw/datasette-mask-columns/releases)\n[![Tests](https://github.com/simonw/datasette-mask-columns/workflows/Test/badge.svg)](https://github.com/simonw/datasette-mask-columns/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-mask-columns/blob/main/LICENSE)\n\nDatasette plugin that masks specified database columns\n\n## Installation\n\n    pip install datasette-mask-columns\n\nThis depends on plugin hook changes in a not-yet released branch of Datasette. See [issue #678](https://github.com/simonw/datasette/issues/678) for details.\n\n## Usage\n\nIn your `metadata.json` file add a section like this describing the database and table in which you wish to mask columns:\n\n```json\n{\n    \"databases\": {\n        \"my-database\": {\n            \"plugins\": {\n                \"datasette-mask-columns\": {\n                    \"users\": [\"password\"]\n                }\n            }\n        }\n    }\n}\n```\nAll SQL queries against the `users` table in `my-database.db` will now return `null` for the `password` column, no matter what value that column actually holds.\n\nThe table page for `users` will display the text `REDACTED` in the masked column. This visual hint will only be available on the table page; it will not display his text for arbitrary queries against the table.\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Datasette plugin that masks specified database columns",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/simonw/datasette-mask-columns"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3edd5321c418f23ddf6fb1c31345d422bd3e2acb935486eb2242efbff8452b8a",
                "md5": "c1fadefb76b5c69cbd2ce5963288c497",
                "sha256": "053eef05ad9b8975440ecd9416dd7a766f2b056bc84490dfa54471ba6d426240"
            },
            "downloads": -1,
            "filename": "datasette_mask_columns-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c1fadefb76b5c69cbd2ce5963288c497",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6955,
            "upload_time": "2023-09-20T02:18:49",
            "upload_time_iso_8601": "2023-09-20T02:18:49.405106Z",
            "url": "https://files.pythonhosted.org/packages/3e/dd/5321c418f23ddf6fb1c31345d422bd3e2acb935486eb2242efbff8452b8a/datasette_mask_columns-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e3432df25a9584e6f68d4cf72e5963101a48c6cc8dcf7d516f8f0170ef5e511c",
                "md5": "2c8ae7da2a1c50f39df685bb9e637885",
                "sha256": "0386263bd751a79ebf2b1fa2d767fe4b2e68dee3153db937283fae8f91494630"
            },
            "downloads": -1,
            "filename": "datasette-mask-columns-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "2c8ae7da2a1c50f39df685bb9e637885",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6926,
            "upload_time": "2023-09-20T02:18:50",
            "upload_time_iso_8601": "2023-09-20T02:18:50.332273Z",
            "url": "https://files.pythonhosted.org/packages/e3/43/2df25a9584e6f68d4cf72e5963101a48c6cc8dcf7d516f8f0170ef5e511c/datasette-mask-columns-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-20 02:18:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonw",
    "github_project": "datasette-mask-columns",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datasette-mask-columns"
}
        
Elapsed time: 0.15628s