README.md

recls.Python

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

Table of Contents

• Introduction
• Installation
• Components
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Efferent (fan-out)
    • Development Dependencies
    • Afferent (fan-in)
  • Related projects
  • License

Introduction

recls (recursive 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:

import recls

print(recls.__version__)

Components

Skeleton; API not yet implemented.

Project Information

Where to get help

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;
• ruff;

Afferent (fan-in)

None (currently).

Related projects

• recls (C/C++);
• recls.Go;
• recls.NET;
• recls.Ruby;
• recls.Rust;

License

recls.Python is released under the 3-clause BSD license. See LICENSE for details.