home / content / repos

repos: 315796015

This data as json

id node_id name full_name private owner html_url description fork created_at updated_at pushed_at homepage size stargazers_count watchers_count language has_issues has_projects has_downloads has_wiki has_pages forks_count archived disabled open_issues_count license topics forks open_issues watchers default_branch permissions temp_clone_token organization network_count subscribers_count readme readme_html allow_forking visibility is_template template_repository web_commit_signoff_required has_discussions
315796015 MDEwOlJlcG9zaXRvcnkzMTU3OTYwMTU= datasette-ripgrep simonw/datasette-ripgrep 0 9599 https://github.com/simonw/datasette-ripgrep Web interface for searching your code using ripgrep, built as a Datasette plugin 0 2020-11-25T01:26:36Z 2022-04-24T03:48:42Z 2022-06-30T22:45:03Z https://ripgrep.datasette.io 55 58 58 Python 1 1 1 1 0 1 0 0 6 apache-2.0 ["codesearch", "datasette", "datasette-io", "datasette-plugin", "ripgrep"] 1 6 58 main {"admin": false, "maintain": false, "push": false, "triage": false, "pull": false}     1 3 # datasette-ripgrep [![PyPI](https://img.shields.io/pypi/v/datasette-ripgrep.svg)](https://pypi.org/project/datasette-ripgrep/) [![Changelog](https://img.shields.io/github/v/release/simonw/datasette-ripgrep?include_prereleases&label=changelog)](https://github.com/simonw/datasette-ripgrep/releases) [![Tests](https://github.com/simonw/datasette-ripgrep/workflows/Test/badge.svg)](https://github.com/simonw/datasette-ripgrep/actions?query=workflow%3ATest) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-ripgrep/blob/main/LICENSE) Web interface for searching your code using [ripgrep](https://github.com/BurntSushi/ripgrep), built as a [Datasette](https://datasette.io/) plugin For background on this project see [datasette-ripgrep: deploy a regular expression search engine for your source code](https://simonwillison.net/2020/Nov/28/datasette-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](https://github.com/simonw). Some example searches: - [with.\*AsyncClient](https://ripgrep.datasette.io/-/ripgrep?pattern=with.*AsyncClient) - regular expression search for `with.*AsyncClient` - [.plugin_config, literal=on](https://ripgrep.datasette.io/-/ripgrep?pattern=.plugin_config\(&literal=on) - a non-regular expression search for `.plugin_config(` - [with.\*AsyncClient glob=datasette/\*\*](https://ripgrep.datasette.io/-/ripgrep?pattern=with.*AsyncClient&glob=datasette%2F%2A%2A) - search for that pattern only within the `datasette/` top folder - ["sqlite-utils\[">\] glob=setup.py](https://ripgrep.datasette.io/-/ripgrep?pattern=%22sqlite-utils%5B%22%3E%5D&glob=setup.py) - a regular expression search for packages that depend on either `sqlite-utils` or `sqlite-utils>=some-version` - [test glob=!\*.html](https://ripgrep.datasette.io/-/ripgrep?pattern=test&glob=%21*.html) - search for the string `test` but exclude results in HTML files ## Installation Install this plugin in the same environment as Datasette. $ datasette install datasette-ripgrep The `rg` executable needs to be [installed](https://github.com/BurntSushi/ripgrep/blob/master/README.md#installation) 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. Create a `metadata.json` file that looks like this: ```json { "plugins": { "datasette-ripgrep": { "path": "/path/to/your/files" } } } ``` Now run Datasette using `datasette -m metadata.json`. The plugin will add an interface at `/-/ripgrep` for running searches. ## Plugin 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 <div id="readme" class="md" data-path="README.md"><article class="markdown-body entry-content container-lg" itemprop="text"><h1 dir="auto"><a id="user-content-datasette-ripgrep" class="anchor" aria-hidden="true" href="#user-content-datasette-ripgrep"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>datasette-ripgrep</h1> <p dir="auto"><a href="https://pypi.org/project/datasette-ripgrep/" rel="nofollow"><img src="https://camo.githubusercontent.com/ebcbf381887ee3c4ed1c9da54876d414e77b4a1c7eb1056f8ea8c7b4a24e8156/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f6461746173657474652d726970677265702e737667" alt="PyPI" data-canonical-src="https://img.shields.io/pypi/v/datasette-ripgrep.svg" style="max-width: 100%;"></a> <a href="https://github.com/simonw/datasette-ripgrep/releases"><img src="https://camo.githubusercontent.com/355fe4e16e5f39a0efea997bbb0d4b0eead22e1975695ca00351fa8f14deb370/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f73696d6f6e772f6461746173657474652d726970677265703f696e636c7564655f70726572656c6561736573266c6162656c3d6368616e67656c6f67" alt="Changelog" data-canonical-src="https://img.shields.io/github/v/release/simonw/datasette-ripgrep?include_prereleases&amp;label=changelog" style="max-width: 100%;"></a> <a href="https://github.com/simonw/datasette-ripgrep/actions?query=workflow%3ATest"><img src="https://github.com/simonw/datasette-ripgrep/workflows/Test/badge.svg" alt="Tests" style="max-width: 100%;"></a> <a href="https://github.com/simonw/datasette-ripgrep/blob/main/LICENSE"><img src="https://camo.githubusercontent.com/1698104e976c681143eb0841f9675c6f802bb7aa832afc0c7a4e719b1f3cf955/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865253230322e302d626c75652e737667" alt="License" data-canonical-src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" style="max-width: 100%;"></a></p> <p dir="auto">Web interface for searching your code using <a href="https://github.com/BurntSushi/ripgrep">ripgrep</a>, built as a <a href="https://datasette.io/" rel="nofollow">Datasette</a> plugin</p> <p dir="auto">For background on this project see <a href="https://simonwillison.net/2020/Nov/28/datasette-ripgrep/" rel="nofollow">datasette-ripgrep: deploy a regular expression search engine for your source code</a>.</p> <h2 dir="auto"><a id="user-content-demo" class="anchor" aria-hidden="true" href="#user-content-demo"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>Demo</h2> <p dir="auto">Try this plugin out at <a href="https://ripgrep.datasette.io/-/ripgrep" rel="nofollow">https://ripgrep.datasette.io/-/ripgrep</a> - where you can run regular expression searches across the source code of Datasette and all of the <code>datasette-*</code> plugins belonging to the <a href="https://github.com/simonw">simonw GitHub user</a>.</p> <p dir="auto">Some example searches:</p> <ul dir="auto"> <li><a href="https://ripgrep.datasette.io/-/ripgrep?pattern=with.*AsyncClient" rel="nofollow">with.*AsyncClient</a> - regular expression search for <code>with.*AsyncClient</code></li> <li><a href="https://ripgrep.datasette.io/-/ripgrep?pattern=.plugin_config(&amp;literal=on" rel="nofollow">.plugin_config, literal=on</a> - a non-regular expression search for <code>.plugin_config(</code></li> <li><a href="https://ripgrep.datasette.io/-/ripgrep?pattern=with.*AsyncClient&amp;glob=datasette%2F%2A%2A" rel="nofollow">with.*AsyncClient glob=datasette/**</a> - search for that pattern only within the <code>datasette/</code> top folder</li> <li><a href="https://ripgrep.datasette.io/-/ripgrep?pattern=%22sqlite-utils%5B%22%3E%5D&amp;glob=setup.py" rel="nofollow">"sqlite-utils["&gt;] glob=setup.py</a> - a regular expression search for packages that depend on either <code>sqlite-utils</code> or <code>sqlite-utils&gt;=some-version</code></li> <li><a href="https://ripgrep.datasette.io/-/ripgrep?pattern=test&amp;glob=%21*.html" rel="nofollow">test glob=!*.html</a> - search for the string <code>test</code> but exclude results in HTML files</li> </ul> <h2 dir="auto"><a id="user-content-installation" class="anchor" aria-hidden="true" href="#user-content-installation"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>Installation</h2> <p dir="auto">Install this plugin in the same environment as Datasette.</p> <div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="$ datasette install datasette-ripgrep"><pre class="notranslate"><code>$ datasette install datasette-ripgrep </code></pre></div> <p dir="auto">The <code>rg</code> executable needs to be <a href="https://github.com/BurntSushi/ripgrep/blob/master/README.md#installation">installed</a> such that it can be run by this tool.</p> <h2 dir="auto"><a id="user-content-usage" class="anchor" aria-hidden="true" href="#user-content-usage"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>Usage</h2> <p dir="auto">This plugin requires configuration: it needs to a <code>path</code> setting so that it knows where to run searches.</p> <p dir="auto">Create a <code>metadata.json</code> file that looks like this:</p> <div class="highlight highlight-source-json notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="{ &quot;plugins&quot;: { &quot;datasette-ripgrep&quot;: { &quot;path&quot;: &quot;/path/to/your/files&quot; } } }"><pre>{ <span class="pl-ent">"plugins"</span>: { <span class="pl-ent">"datasette-ripgrep"</span>: { <span class="pl-ent">"path"</span>: <span class="pl-s"><span class="pl-pds">"</span>/path/to/your/files<span class="pl-pds">"</span></span> } } }</pre></div> <p dir="auto">Now run Datasette using <code>datasette -m metadata.json</code>. The plugin will add an interface at <code>/-/ripgrep</code> for running searches.</p> <h2 dir="auto"><a id="user-content-plugin-configuration" class="anchor" aria-hidden="true" href="#user-content-plugin-configuration"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>Plugin configuration</h2> <p dir="auto">The <code>"path"</code> configuration is required. Optional extra configuration options are:</p> <ul dir="auto"> <li><code>time_limit</code> - floating point number. The <code>rg</code> process will be terminated if it takes longer than this limit. The default is one second, <code>1.0</code>.</li> <li><code>max_lines</code> - integer. The <code>rg</code> process will be terminated if it returns more than this number of lines. The default is <code>2000</code>.</li> </ul> <h2 dir="auto"><a id="user-content-development" class="anchor" aria-hidden="true" href="#user-content-development"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>Development</h2> <p dir="auto">To set up this plugin locally, first checkout the code. Then create a new virtual environment:</p> <div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="cd datasette-ripgrep python3 -mvenv venv source venv/bin/activate"><pre class="notranslate"><code>cd datasette-ripgrep python3 -mvenv venv source venv/bin/activate </code></pre></div> <p dir="auto">Or if you are using <code>pipenv</code>:</p> <div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="pipenv shell"><pre class="notranslate"><code>pipenv shell </code></pre></div> <p dir="auto">Now install the dependencies and tests:</p> <div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="pip install -e '.[test]'"><pre class="notranslate"><code>pip install -e '.[test]' </code></pre></div> <p dir="auto">To run the tests:</p> <div class="snippet-clipboard-content notranslate position-relative overflow-auto" data-snippet-clipboard-copy-content="pytest"><pre class="notranslate"><code>pytest </code></pre></div> </article></div> 1 public 0   0  

Links from other tables

  • 11 rows from repo in releases
Powered by Datasette · Queries took 1.451ms