Skip to main content

A powerful, format-agnostic search tool

Project description

Super Grep

GitHub stars GitHub license PyPI version

Super Grep is a powerful, format-agnostic search tool that allows you to search for patterns in files and directories with ease. It supports various naming conventions and provides options for controlling search depth, file content searching, and output colorization.

Features

  • Format-agnostic pattern matching (supports camelCase, snake_case, PascalCase, kebab-case, Title Case, Capitalized With Spaces, etc.)
  • Configurable search depth
  • File content searching
  • Colorized output
  • Multi-processing for improved performance

Installation

You can install Super Grep using pip:

pip install super-grep

Usage

After installation, you can use the super-grep command directly from your terminal:

super-grep [OPTIONS] DIRECTORY PATTERN

Options

  • --workers NUMBER: Number of worker processes (default: CPU count)
  • --contents: Search within file contents (default: search filenames only)
  • --color: Colorize the output
  • --depth NUMBER: Depth of directory search (default: 0, search only in given directory; use -1 for unlimited depth)

Examples

  1. Search only in the given directory:

    super-grep /path/to/search "FooBar|first_name"
    
  2. Search up to 2 levels deep:

    super-grep /path/to/search "FooBar|first_name" --depth 2
    
  3. Search all subdirectories:

    super-grep /path/to/search "FooBar|first_name" --depth -1
    
  4. Search file contents up to 3 levels deep with colored output:

    super-grep /path/to/search "FooBar|first_name" --depth 3 --contents --color
    
  5. Use 8 worker processes:

    super-grep /path/to/search "FooBar|first_name" --workers 8
    

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support the Project

If you find Super Grep useful, please consider supporting its development. See the SUPPORT.md file included in this package for more information on how you can contribute.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Supporting Super Grep

If you find Super Grep useful and would like to support its development, there are several ways you can contribute:

Financial Support

You can make a financial contribution to the project via:

Other Ways to Support

  • Star the project on GitHub
  • Report bugs or suggest features by opening issues on GitHub
  • Contribute code by submitting pull requests
  • Spread the word about Super Grep to your colleagues and friends

Your support, in any form, is greatly appreciated and helps to ensure the continued development and maintenance of Super Grep. Thank you!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

super_grep-0.1.3.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

super_grep-0.1.3-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file super_grep-0.1.3.tar.gz.

File metadata

  • Download URL: super_grep-0.1.3.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for super_grep-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0d6e10d0c53f77f0c3712e1cc5c89bd58dd6ff2af6b6685e28598d6163ac5c90
MD5 54281c3f8cda26b2210e29827cae133d
BLAKE2b-256 f5f9b0d6ac63174d52f09d626dee4007ceaed14bb891d7c8e09b7f2f12a3e830

See more details on using hashes here.

File details

Details for the file super_grep-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: super_grep-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for super_grep-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8e8b33f9b72dd2a875b9a0b0fc3a4a53aa443d54cffd2d4bedf5126ec7fc8733
MD5 1a35b3526e962c682e7c5d82fbda3b1b
BLAKE2b-256 f9e2ef727b86ef3fc8ebfd4c6e8f55ffefe0730de4c8d290cfca09a8b431aa8a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page