Skip to content
python module for ripgrep
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs 1.0.1 version bump and minor fixes Jul 17, 2019
ripgrepy 1.0.1 version bump and minor fixes Jul 17, 2019
tests refactors and logo Jul 17, 2019
.gitignore refactors and logo Jul 17, 2019
.travis.yml . May 2, 2019
LICENSE Initial commit May 1, 2019
README.md refactors and logo Jul 17, 2019
logo.png refactors and logo Jul 17, 2019
requirements.txt initial push May 2, 2019
setup.cfg initial push May 2, 2019
setup.py 1.0.1 version bump and minor fixes Jul 17, 2019

README.md

Build Status Documentation PyPI

ripgrepy

ripgrepy is a python interface to ripgrep. It is written to support Python 3.7+ only and is built on ripgrep version 11.0.1

For complete usage and details, refer to the docs at

Readthedocs

Instal

Use pip to install

pip install ripgrepy

Requirements

ripgrepy leverages the system ripgrep to run its commands. So either the standalone binary, rg in $PATH or a path to ripgrep needs to be provided.

Usage

Ripgrep is a simple module that allows chaining ripgrep options on top of each other and get the result back. There is a couple of helper methods included to help in parsing, such as the as_dict module which shows all valid matches as a dictionary object.

To instantiate the class, use:

from ripgrepy import Ripgrepy
# The Ripgrepy class takes two arguments. The regex to search for and the folder path to search in

rg = Ripgrepy('he[l]{2}o', '/some/path/to/files')

The syntax for ripgrepy is simliar to that of ripgrep itself.

rg.with_filename().line_number()...run().as_string

# the same can be executed using the rg shorthands

rg.H().n().run().as_string

The above is eqivalent to running

rg --with-filename --line-number "he[l]{2}o" /path/to/some/files

Important run() should always be the last method that is being run followed by one of the output methods. If ripgrep options are placed after run, they will not be part of the command being executed. Refer to Readthedocs for complete documentation. The docs are obtained from ripgreps man pages itself.

Output methods

Output can be obtained using the following three properties

  • as_dict
  • as_json
  • as_string

Not all ripgrep output is compitable with as_dict and as_json output formats

You can’t perform that action at this time.