datasette-metadata-editable


Namedatasette-metadata-editable JSON
Version 0.2a0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-08-06 18:02:14
maintainerNone
docs_urlNone
authorAlex Garcia
requires_python>=3.8
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # datasette-metadata-editable

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

A Datasette plugin for editing instance, database and table metadata. Currently requires [Datasette 1.0a14](https://docs.datasette.io/en/latest/changelog.html#a14-2024-08-05) or higher.

## Installation

Install this plugin in the same environment as Datasette.

```bash
datasette install datasette-metadata-editable
```

## Usage

This plugin _must_ be used with a persistent `internal.db` database. If you don't configure Datasette in this way any changes made to metadata will be lost when the server restarts.

Be sure to start Datasette something like this:

```bash
datasette --internal internal.db
```

Users with the `datasette-metadata-editable-edit` permission will see action menu items for editing the metadata attached to the instance, a database or a table.

An easy way to test the plugin is like this, which will allow even logged out users to edit metadata:

```bash
datasette --internal internal.db -s permissions.datasette-metadata-editable-edit true
```
Or to restrict edits to the `root` user:
```bash
datasette --internal internal.db -s permissions.datasette-metadata-editable-edit.id root --root
```

## Development

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

```bash
cd datasette-metadata-editable
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
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "datasette-metadata-editable",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Alex Garcia",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/70/8c/adabb998ee917e1576a0286ed9d965a927a2a2e96c70be24db009f991a9d/datasette_metadata_editable-0.2a0.tar.gz",
    "platform": null,
    "description": "# datasette-metadata-editable\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-metadata-editable.svg)](https://pypi.org/project/datasette-metadata-editable/)\n[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-metadata-editable?include_prereleases&label=changelog)](https://github.com/datasette/datasette-metadata-editable/releases)\n[![Tests](https://github.com/datasette/datasette-metadata-editable/workflows/Test/badge.svg)](https://github.com/datasette/datasette-metadata-editable/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-metadata-editable/blob/main/LICENSE)\n\nA Datasette plugin for editing instance, database and table metadata. Currently requires [Datasette 1.0a14](https://docs.datasette.io/en/latest/changelog.html#a14-2024-08-05) or higher.\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n\n```bash\ndatasette install datasette-metadata-editable\n```\n\n## Usage\n\nThis plugin _must_ be used with a persistent `internal.db` database. If you don't configure Datasette in this way any changes made to metadata will be lost when the server restarts.\n\nBe sure to start Datasette something like this:\n\n```bash\ndatasette --internal internal.db\n```\n\nUsers with the `datasette-metadata-editable-edit` permission will see action menu items for editing the metadata attached to the instance, a database or a table.\n\nAn easy way to test the plugin is like this, which will allow even logged out users to edit metadata:\n\n```bash\ndatasette --internal internal.db -s permissions.datasette-metadata-editable-edit true\n```\nOr to restrict edits to the `root` user:\n```bash\ndatasette --internal internal.db -s permissions.datasette-metadata-editable-edit.id root --root\n```\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n\n```bash\ncd datasette-metadata-editable\npython3 -m venv venv\nsource venv/bin/activate\n```\n\nNow install the dependencies and test dependencies:\n\n```bash\npip install -e '.[test]'\n```\n\nTo run the tests:\n\n```bash\npytest\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": null,
    "version": "0.2a0",
    "project_urls": {
        "CI": "https://github.com/datasette/datasette-metadata-editable/actions",
        "Changelog": "https://github.com/datasette/datasette-metadata-editable/releases",
        "Homepage": "https://github.com/datasette/datasette-metadata-editable",
        "Issues": "https://github.com/datasette/datasette-metadata-editable/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e69283bef99cf204cc47df4770d45ddf6c4eed63ce417bfa0fccc65d288b1c5",
                "md5": "e5fcc315c76c971a767d21a153be4d1d",
                "sha256": "70d57cf1615f98efefb73ad7e21e8c6071abf1c5c84a881d3b8bb2e3b6377309"
            },
            "downloads": -1,
            "filename": "datasette_metadata_editable-0.2a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e5fcc315c76c971a767d21a153be4d1d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 11416,
            "upload_time": "2024-08-06T18:02:12",
            "upload_time_iso_8601": "2024-08-06T18:02:12.860148Z",
            "url": "https://files.pythonhosted.org/packages/9e/69/283bef99cf204cc47df4770d45ddf6c4eed63ce417bfa0fccc65d288b1c5/datasette_metadata_editable-0.2a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "708cadabb998ee917e1576a0286ed9d965a927a2a2e96c70be24db009f991a9d",
                "md5": "f7ef8edeacec815fe9d68c8b5dae0e91",
                "sha256": "ac313bde73f28a91ad58c3a99ae86e18f3c2397a3d37b33fed9eb84f0844b167"
            },
            "downloads": -1,
            "filename": "datasette_metadata_editable-0.2a0.tar.gz",
            "has_sig": false,
            "md5_digest": "f7ef8edeacec815fe9d68c8b5dae0e91",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13805,
            "upload_time": "2024-08-06T18:02:14",
            "upload_time_iso_8601": "2024-08-06T18:02:14.118272Z",
            "url": "https://files.pythonhosted.org/packages/70/8c/adabb998ee917e1576a0286ed9d965a927a2a2e96c70be24db009f991a9d/datasette_metadata_editable-0.2a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-06 18:02:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "datasette",
    "github_project": "datasette-metadata-editable",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datasette-metadata-editable"
}
Alex Garcia
Elapsed time: 0.66042s