Metadata-Version: 2.1
Name: fdpy
Version: 0.1.0
Summary: Unofficial fd port for Python
Author-email: Alyetama <56323389+Alyetama@users.noreply.github.com>
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Project-URL: Home, https://github.comm/Alyetama/fdpy

# fdpy

Crude Python port of [fd](https://github.com/sharkdp/fd).

## Requirements
- [fd](https://github.com/sharkdp/fd)
- [python>=3.6](https://www.python.org/downloads/)

## Installation

First, install `fd` (see [sharkdp/fd#installation](https://github.com/sharkdp/fd#installation) for instructions). Then install the package with

```
pip install fdpy
```

❗ **IMPORTANT: `fd` must be in your `$PATH`**

## Usage

```py
>>> from fdpy.fd import FD
>>> fd = FD()
>>> fd.find('foo.txt')
# ['/path/to/cwd/foo.txt', '/path/to/cwd/foo.jpg']
>>> fd.find('Foo.txt', path='/some/dir', hidden=True, no_ignore=True, case_sensitive=True)
# ['/some/dir/Foo.txt', '/some/dir/.Foo']
```

