Skip to main content

datasette-ripgrep

PyPI Changelog Tests License

Configurable Datasette plugin running ripgrep

Demo

Try this plugin out at https://ripgrep.datasette.io/-/ripgrep - where you can run regular expression searches across the source code of Datasette and all of the datasette-* plugins belonging to the simonw GitHub user.

Installation

Install this plugin in the same environment as Datasette.

$ datasette install datasette-ripgrep

The rg executable needs to be installed such that it can be run by this tool.

Usage

This plugin requires configuration: it needs to a path setting so that it knows where to run searches:

{
    "plugins": {
        "datasette-ripgrep": {
            "path": "/path/to/your/files"
        }
    }
}

The plugin will add an interface at /-/ripgrep for running searches.

Configuration

The "path" configuration is required. Optional extra configuration options are:

  • time_limit - floating point number. The rg process will be terminated if it takes longer than this limit. The default is one second, 1.0.
  • max_lines - integer. The rg process will be terminated if it returns more than this number of lines. The default is 2000.

Development

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

cd datasette-ripgrep
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

Metadata

Release files for datasette-ripgrep 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for datasette-ripgrep 0.1
File Size Uploaded Provenance Actions
datasette-ripgrep-0.1.tar.gz 3.8 kB Without provenance Details for datasette-ripgrep-0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for datasette-ripgrep 0.1
File Interpreter ABI Platform Actions
datasette_ripgrep-0.1-py3-none-any.whl Python 3 none any Details for datasette_ripgrep-0.1-py3-none-any.whl

Total release size: 7.9 kB

Release files / datasette-ripgrep-0.1.tar.gz

Download URL datasette-ripgrep-0.1.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
57526c6e4f11a8d244bd00f7fe86425858f46fcaeb2588ef4ec0e34e1a78002b
BLAKE2b-256 checksum
How to use checksums
c54f3d6f881e725a8b4aee00c2777433c27828325a9776969ef9148b3f14ffb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

Release files / datasette_ripgrep-0.1-py3-none-any.whl

Download URL datasette_ripgrep-0.1-py3-none-any.whl
Size 4.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
378cef162952a42624dbf4ceac29f20a802cb01375a7c69c4e83aa965b87a33e
BLAKE2b-256 checksum
How to use checksums
01136c4a8e5bd48bbdc92456a443a1e226e8722513cb4890588da76d759f5672
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

Security for datasette-ripgrep 0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page