Metadata-Version: 2.1
Name: datasette-block-robots
Version: 0.2
Summary: Datasette plugin that blocks all robots using robots.txt
Home-page: https://github.com/simonw/datasette-block-robots
Author: Simon Willison
License: Apache License, Version 2.0
Project-URL: Issues, https://github.com/simonw/datasette-block-robots/issues
Project-URL: CI, https://github.com/simonw/datasette-block-robots/actions
Project-URL: Changelog, https://github.com/simonw/datasette-block-robots/releases
Description: # datasette-block-robots
        
        [![PyPI](https://img.shields.io/pypi/v/datasette-block-robots.svg)](https://pypi.org/project/datasette-block-robots/)
        [![Changelog](https://img.shields.io/github/v/release/simonw/datasette-block-robots?label=changelog)](https://github.com/simonw/datasette-block-robots/releases)
        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-block-robots/blob/master/LICENSE)
        
        Datasette plugin that blocks all robots using robots.txt
        
        ## Installation
        
        Install this plugin in the same environment as Datasette.
        
            $ pip install datasette-block-robots
        
        ## Usage
        
        Having installed the plugin, `/robots.txt` on your Datasette instance will return the following:
        
            User-agent: *
            Disallow: /
        
        Here's a demo of the plugin in action: https://sqlite-generate-demo.datasette.io/robots.txt
        
        ## Configuration
        
        By default the plugin will block all access to the site, using `Disallow: /`.
        
        You can instead block access to specific areas of the site by adding the following to your `metadata.json` configuration file:
        
        ```json
        {
            "plugins": {
                "datasette-block-robots": {
                    "disallow": ["/mydatabase"]
                }
            }
        }
        ```
        This will result in a `/robots.txt` that looks like this:
        
            User-agent: *
            Disallow: /mydatabase
        
        ## Development
        
        To set up this plugin locally, first checkout the code. Then create a new virtual environment:
        
            cd datasette-block-robots
            python3 -mvenv venv
            source venv/bin/activate
        
        Or if you are using `pipenv`:
        
            pipenv shell
        
        Now install the dependencies and tests:
        
            pip install -e '.[test]'
        
        To run the tests:
        
            pytest
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
