datasette-homepage-table


Namedatasette-homepage-table JSON
Version 0.2 PyPI version JSON
download
home_page
SummaryShow a specific Datasette table on the homepage
upload_time2024-01-31 18:51:57
maintainer
docs_urlNone
authorSimon Willison
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-homepage-table

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

Show a specific Datasette table on the homepage

## Installation

Install this plugin in the same environment as Datasette.
```bash
datasette install datasette-homepage-table
```
## Usage

This plugin changes the Datasette homepage to display a table instead of the default list of databases.

Without configuration, it will take the first table in the first attached database.

Alternatively you can configure it like this:

```json
{
    "plugins": {
        "datasette-homepage-table": {
            "database": "mydatabase",
            "table": "mytable"
        }
    }
}
```
Both keys are optional: if you omit `database` it will use the first attached database, and if you omit `table` it will use the first table in the database.

You can customize the `table.html` template to [change the appearance of the table](https://docs.datasette.io/en/stable/custom_templates.html#custom-templates).

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd datasette-homepage-table
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": "",
    "name": "datasette-homepage-table",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Simon Willison",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d3/e7/3682a3abd0a77554bac52398705ab5be9222c8f5faa60d2d914d4cf86e33/datasette-homepage-table-0.2.tar.gz",
    "platform": null,
    "description": "# datasette-homepage-table\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-homepage-table.svg)](https://pypi.org/project/datasette-homepage-table/)\n[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-homepage-table?include_prereleases&label=changelog)](https://github.com/datasette/datasette-homepage-table/releases)\n[![Tests](https://github.com/datasette/datasette-homepage-table/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-homepage-table/actions/workflows/test.yml)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-homepage-table/blob/main/LICENSE)\n\nShow a specific Datasette table on the homepage\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n```bash\ndatasette install datasette-homepage-table\n```\n## Usage\n\nThis plugin changes the Datasette homepage to display a table instead of the default list of databases.\n\nWithout configuration, it will take the first table in the first attached database.\n\nAlternatively you can configure it like this:\n\n```json\n{\n    \"plugins\": {\n        \"datasette-homepage-table\": {\n            \"database\": \"mydatabase\",\n            \"table\": \"mytable\"\n        }\n    }\n}\n```\nBoth keys are optional: if you omit `database` it will use the first attached database, and if you omit `table` it will use the first table in the database.\n\nYou can customize the `table.html` template to [change the appearance of the table](https://docs.datasette.io/en/stable/custom_templates.html#custom-templates).\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n```bash\ncd datasette-homepage-table\npython3 -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\npip install -e '.[test]'\n```\nTo run the tests:\n```bash\npytest\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Show a specific Datasette table on the homepage",
    "version": "0.2",
    "project_urls": {
        "CI": "https://github.com/datasette/datasette-homepage-table/actions",
        "Changelog": "https://github.com/datasette/datasette-homepage-table/releases",
        "Homepage": "https://github.com/datasette/datasette-homepage-table",
        "Issues": "https://github.com/datasette/datasette-homepage-table/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5258d2b08cd8076274369ec4ab5d100de9f1307931d3ae387e3b2377b64b8946",
                "md5": "52da0311af7175c5581b5fe93d9626b3",
                "sha256": "97adcbf4265ad3f171487183d71605ef3e36d206710c52867dedac8bf9135071"
            },
            "downloads": -1,
            "filename": "datasette_homepage_table-0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "52da0311af7175c5581b5fe93d9626b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7150,
            "upload_time": "2024-01-31T18:51:55",
            "upload_time_iso_8601": "2024-01-31T18:51:55.737553Z",
            "url": "https://files.pythonhosted.org/packages/52/58/d2b08cd8076274369ec4ab5d100de9f1307931d3ae387e3b2377b64b8946/datasette_homepage_table-0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3e73682a3abd0a77554bac52398705ab5be9222c8f5faa60d2d914d4cf86e33",
                "md5": "29d71c7138ffadf940ba7517064ca884",
                "sha256": "7a5b67e86f5cb73095d1f1125e2fc7d4bb4db6461427af9f6e00649990f5dd25"
            },
            "downloads": -1,
            "filename": "datasette-homepage-table-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "29d71c7138ffadf940ba7517064ca884",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7200,
            "upload_time": "2024-01-31T18:51:57",
            "upload_time_iso_8601": "2024-01-31T18:51:57.189854Z",
            "url": "https://files.pythonhosted.org/packages/d3/e7/3682a3abd0a77554bac52398705ab5be9222c8f5faa60d2d914d4cf86e33/datasette-homepage-table-0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-31 18:51:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "datasette",
    "github_project": "datasette-homepage-table",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datasette-homepage-table"
}
        
Elapsed time: 0.41509s