Report Bug · Request Feature · Ask Question · Report security bug

Table of Contents

• Requirements
• Installation
  • From PyPI
  • Manual installation
  • Uninstall
• Usage
• Contributors
  • How do I contribute to findr?
• License
• Credits

Requirements

Here's a breakdown of the packages needed and their versions:

• rich (version 13.7.0)

[!NOTE] The software has been developed and tested using Python 3.12.1. The minimum required version to run the software is Python 3.6. Although the software may work with previous versions, it is not guaranteed.

Installation

From PyPI

findr can be installed easily as a PyPI package. Just run the following command:

pip3 install pyfindr

[!IMPORTANT] For best practices and to avoid potential conflicts with your global Python environment, it is strongly recommended to install this program within a virtual environment. Avoid using the --user option for global installations. We highly recommend using pipx for a safe and isolated installation experience. Therefore, the appropriate command to install findr would be:

pipx install pyfindr

The program can now be ran from a terminal with the findr command.

Manual installation

If you prefer to install the program manually, follow these steps:

[!WARNING] This will install the version from the latest commit, not the latest release.

1. Download the latest version of findr from this repository:

   git clone https://github.com/YisusChrist/findr
   cd findr
   

2. Install the package:

   poetry install
   

3. Run the program:

   poetry run findr
   

Uninstall

If you installed it from PyPI, you can use the following command:

pipx uninstall pyfindr

Usage

Search for a match in file contents.

Search for a match in filenames.

usage: findr key
             [--path PATH]
             [--mode {contents,filenames}]
             [--max-depth MAX_DEPTH]
             [--skip-dotfiles]
             [-h] [-v] [-d] [-V]

Recursively search files

Main Options:
  key                   The string to search for.
  --path PATH           the path to search under (default: D:\Documents\development\findr)
  --mode {contents,filenames}
                        The search mode. Default is 'contents'.
  --max-depth MAX_DEPTH
                        maximum depth for recursive search
  --skip-dotfiles       skip dotfiles

Miscellaneous Options:
  -h, --help            Show this help message and exit.
  -v, --verbose         Show log messages on screen. Default is False.
  -d, --debug           Activate debug logs. Default is False.
  -V, --version         Show version number and exit.

Contributors

How do I contribute to findr?

Before you participate in our delightful community, please read the code of conduct.

I'm far from being an expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!

We also need people to test out pull requests. So take a look through the open issues and help where you can.

See Contributing for more details.

License

findr is released under the GPL-2.0 license.

Credits

[!NOTE] Credits to Julynx for creating the original project. I only make improvements in his code based on my preferences to customize it. All the ideas and the base of the script are his.