Skip to main content

ff

About

ff is a tool for finding files in the filesystem.

NOTE: ff is in the early stages of development, expect things to break and syntax to change.

Summary

ff lets you find files in the filesystem by querying file metadata. Its scope is similar to find(1) and fd(1) but it tries to be more accessible and easier to use than find and and more versatile and powerful than fd. It is written in Python >= 3.6.

Features

  • Search by file attributes.
  • Search in a wide variety of file metadata.
  • Simple yet powerful expression syntax.
  • Flexible output options.
  • Flexible sort options.
  • Extendable by user plugins.
  • Parallel search and processing.
  • Usable in scripts with a Python API.

Examples

Store all files from the current directory that are tracked by git(1) in a tar(1) archive:

$ ff type=f git.tracked=yes --sort --exec-batch tar cvzf git-tracked.tar.gz

Find files in the directory Videos/ that end with .mkv or .mp4 and are between 720 and 1080 pixels high:

$ ff Videos/ {{ ext=mkv or ext=mp4 }} and {{ height+=720 and height-=1080 }}

More examples are here.

Installation

To build and install ff simply type:

$ python setup.py install

or

$ pip install find-ff

This installs the python sources, the ff script, the man page and a set of plugins.

Python API

You can use ff's query capabilities in your own scripts:

from libff.search import Search

for entry in Search("type=f git.tracked=yes", directories=["/home/user/project"], sort=["path"]):
    print(entry["relpath"])

Developing plugins and debug mode

There is a template for new plugins to start from (plugin_template.py) with exhaustive instructions and comments, so you can develop plugins for your own needs.

Useful in that regard is ff's debug mode. It can be activated by executing the libff module.

$ python -m libff --debug info,cache ...

Debug mode produces lots of messages which can be limited to certain categories using the --debug category1,category2,... option. On top of that, debug mode activates many internal checks using assert(). Therefore, it is advisable to use debug mode during plugin development.

Metadata

Release files for find-ff 535

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for find-ff 535
File Size Uploaded Provenance Actions
find-ff-535.tar.gz 57.7 kB Without provenance Details for find-ff-535.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for find-ff 535
File Interpreter ABI Platform Actions
find_ff-535-py3-none-any.whl Python 3 none any Details for find_ff-535-py3-none-any.whl

Total release size: 150.9 kB

Release files / find-ff-535.tar.gz

Download URL find-ff-535.tar.gz
Size 57.7 kB
Tags Source
SHA-256 checksum
How to use checksums
40a2355411909d8c2a6f52fcac3a9f51e124c7275a8d1e7776c168f12ab2e24c
BLAKE2b-256 checksum
How to use checksums
bc3be4639c83bdf1142067f252b642053326298eef59e0837b0479271f12d776
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

Release files / find_ff-535-py3-none-any.whl

Download URL find_ff-535-py3-none-any.whl
Size 93.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2ed18bec320904c6ad0df57bb4e8e35b2b5f0efa1ae664a9411e9bc94b2262db
BLAKE2b-256 checksum
How to use checksums
18fc3fd7cbdd5fcb9ebc3cf02002525d4b02c5299f5823d8f55abbb20005f794
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

Security for find-ff 535

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

535 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page