Metadata-Version: 2.4
Name: recls
Version: 0.0.0.1
Summary: Platform-independent recursive file-system search library, for Python
Home-page: https://github.com/synesissoftware/recls.Python
Author: Matt Wilson
Author-email: Matt Wilson <matthew@synesis.com.au>
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/synesissoftware/recls.Python/issues
Project-URL: Changelog, https://github.com/synesissoftware/recls.Python/blob/master/CHANGES.md
Project-URL: Homepage, https://github.com/synesissoftware/recls.Python
Project-URL: Repository, https://github.com/synesissoftware/recls.Python
Keywords: filesystem,recursive,recls,search
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Filesystems
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Provides-Extra: dev
Requires-Dist: pytest<5,>=4.6; python_version < "3" and extra == "dev"
Requires-Dist: pytest>=7; python_version >= "3.8" and extra == "dev"
Requires-Dist: ruff>=0.4.0; python_version >= "3.8" and extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# recls.Python <!-- omit in toc -->

Platform-independent recursive file-system search library, for Python

![Language](https://img.shields.io/badge/Python-3776AB?style=flat&logo=python&logoColor=white)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![PyPI](https://img.shields.io/pypi/v/recls.svg)](https://pypi.org/project/recls/)
[![GitHub release](https://img.shields.io/github/v/release/synesissoftware/recls.Python.svg)](https://github.com/synesissoftware/recls.Python/releases/latest)
[![Last Commit](https://img.shields.io/github/last-commit/synesissoftware/recls.Python)](https://github.com/synesissoftware/recls.Python/commits/master)
[![CI](https://github.com/synesissoftware/recls.Python/actions/workflows/python-package.yml/badge.svg)](https://github.com/synesissoftware/recls.Python/actions/workflows/python-package.yml)
![Python](https://img.shields.io/badge/Python-2.7%20%7C%203.8+-lightgrey)


## Table of Contents <!-- omit in toc -->

- [Introduction](#introduction)
- [Installation](#installation)
- [Components](#components)
- [Project Information](#project-information)
  - [Where to get help](#where-to-get-help)
  - [Contribution guidelines](#contribution-guidelines)
  - [Dependencies](#dependencies)
    - [Efferent (fan-out)](#efferent-fan-out)
    - [Development Dependencies](#development-dependencies)
    - [Afferent (fan-in)](#afferent-fan-in)
  - [Related projects](#related-projects)
  - [License](#license)


## Introduction

**recls** (**rec**ursive **ls**) provides platform-independent recursive file-system search.

**recls.Python** is the **Python** implementation. It supports **Python 2.7** and **Python 3.8+**. This repository is a packaging skeleton; the search API is not implemented yet.


## Installation

Install via **pip**:

```
pip install recls
```

Use via **import**:

```Python
import recls

print(recls.__version__)
```


## Components

Skeleton; API not yet implemented.


## Project Information


### Where to get help

[GitHub Page](https://github.com/synesissoftware/recls.Python "GitHub Page")


### Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recls.Python.


### Dependencies


#### Efferent (fan-out)

None.


#### Development Dependencies

* [**pytest**](https://docs.pytest.org/);
* [**ruff**](https://docs.astral.sh/ruff/);


#### Afferent (fan-in)

None (currently).


### Related projects

* [**recls** (C/C++)](https://github.com/synesissoftware/recls);
* [**recls.Go**](https://github.com/synesissoftware/recls.Go);
* [**recls.NET**](https://github.com/synesissoftware/recls.NET);
* [**recls.Ruby**](https://github.com/synesissoftware/recls.Ruby);
* [**recls.Rust**](https://github.com/synesissoftware/recls.Rust);


### License

**recls.Python** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.


<!-- ########################### end of file ########################### -->
