Metadata-Version: 2.1
Name: datasette-remote-metadata
Version: 0.1
Summary: Periodically refresh Datasette metadata from a remote URL
Home-page: https://github.com/simonw/datasette-remote-metadata
Author: Simon Willison
License: Apache License, Version 2.0
Project-URL: Issues, https://github.com/simonw/datasette-remote-metadata/issues
Project-URL: CI, https://github.com/simonw/datasette-remote-metadata/actions
Project-URL: Changelog, https://github.com/simonw/datasette-remote-metadata/releases
Description: # datasette-remote-metadata
        
        [![PyPI](https://img.shields.io/pypi/v/datasette-remote-metadata.svg)](https://pypi.org/project/datasette-remote-metadata/)
        [![Changelog](https://img.shields.io/github/v/release/simonw/datasette-remote-metadata?include_prereleases&label=changelog)](https://github.com/simonw/datasette-remote-metadata/releases)
        [![Tests](https://github.com/simonw/datasette-remote-metadata/workflows/Test/badge.svg)](https://github.com/simonw/datasette-remote-metadata/actions?query=workflow%3ATest)
        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-remote-metadata/blob/main/LICENSE)
        
        Periodically refresh Datasette metadata from a remote URL
        
        ## Installation
        
        Install this plugin in the same environment as Datasette.
        
            $ datasette install datasette-remote-metadata
        
        ## Usage
        
        Add the following to your `metadata.json`:
        
        ```json
        {
            "plugins": {
                "datasette-remote-metadata": {
                    "url": "https://example.com/remote-metadata.yml"
                }
            }
        }
        ```
        The plugin will fetch the specified metadata  from that URL at startup and combine it with any existing metadata. You can use a URL to either a JSON file or a YAML file.
        
        It will periodically refresh that metadata - by default every 30 seconds, unless you specify an alternative `"ttl"` value in the plugin configuration.
        
        ## Configuration
        
        Available configuration options are as follows:
        
        - `"url"` - the URL to retrieve remote metadata from. Can link to a JSON or a YAML file.
        - `"ttl"` - integer value in secords: how frequently should the script check for fresh metadata. Defaults to 30 seconds.
        - `"headers"` - a dictionary of additional request headers to send.
        - `"cachebust"` - if true, a random `?0.29508` value will be added to the query string of the remote metadata to bust any intermediary caches.
        
        This example `metadata.json` configuration refreshes every 10 seconds, uses cache busting and sends an `Authorization: Bearer xyz` header with the request:
        
        ```json
        {
            "plugins": {
                "datasette-remote-metadata": {
                    "url": "https://example.com/remote-metadata.yml",
                    "ttl": 10,
                    "cachebust": true,
                    "headers": {
                        "Authorization": "Bearer xyz"
                    }
                }
            }
        }
        ```
        This example if you are using `metadata.yaml` for configuration:
        ```yaml
        plugins:
          datasette-remote-metadata:
            url: https://example.com/remote-metadata.yml
            ttl: 10
            cachebust: true
            headers:
              Authorization: Bearer xyz
        ```
        
        ## Development
        
        To set up this plugin locally, first checkout the code. Then create a new virtual environment:
        
            cd datasette-remote-metadata
            python3 -mvenv venv
            source venv/bin/activate
        
        Or if you are using `pipenv`:
        
            pipenv shell
        
        Now install the dependencies and test dependencies:
        
            pip install -e '.[test]'
        
        To run the tests:
        
            pytest
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
