https://github.com/securisec/ripgrepy

python module for ripgrep
https://github.com/securisec/ripgrepy

grep python37 ripgrep

Last synced: 6 months ago
JSON representation

python module for ripgrep

• Host: GitHub
• URL: https://github.com/securisec/ripgrepy
• Owner: securisec
• License: gpl-3.0
• Created: 2019-05-01T11:32:25.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-07-01T21:00:40.000Z (6 months ago)
• Last Synced: 2025-07-01T22:19:14.200Z (6 months ago)
• Topics: grep, python37, ripgrep
• Language: Python
• Homepage:
• Size: 309 KB
• Stars: 61
• Watchers: 1
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/securisec/ripgrepy.svg?branch=master)](https://travis-ci.com/securisec/ripgrepy)

[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](http://ripgrepy.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/ripgrepy.svg?logo=python&color=blue)](https://pypi.org/project/ripgrepy/)



# 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](http://ripgrepy.readthedocs.io/en/latest/)

## 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](http://ripgrepy.readthedocs.io/en/latest/) 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