Configurable Datasette plugin running ripgrep
Project description
datasette-ripgrep
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. Therg
process will be terminated if it takes longer than this limit. The default is one second,1.0
.max_lines
- integer. Therg
process will be terminated if it returns more than this number of lines. The default is2000
.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for datasette_ripgrep-0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eba045e0f9d0f415f7d4215395c5ce5ec55e490089ca717cc8b88eb887c4ca1f |
|
MD5 | b23f8832c90fe1ee52e6431987c1d492 |
|
BLAKE2b-256 | e6eee5e54c3b98af6b1f71b88b420fecf1d81654a42becc2fb59c2ebbe28f160 |