pathlib3 Documentation

Welcome to pathlib3 - an extended version of Python’s pathlib with 40+ additional utility methods!

What is pathlib3?

pathlib3 extends Python’s standard pathlib.Path class with convenient utility methods for common file and directory operations. It maintains 100% backward compatibility with pathlib.Path while adding powerful new features.

Key Features

• ✅ 100% Compatible with pathlib.Path

• ✅ 40+ New Methods for file operations

• ✅ Type Hints for better IDE support

• ✅ Method Chaining support

• ✅ Zero Dependencies (only standard library)

• ✅ Well Documented with examples

Quick Start

from pathlib3 import Path

# Use all standard pathlib.Path methods
p = Path("myfile.txt")
p.exists()          # Standard pathlib
p.read_text()       # Standard pathlib

# Plus 40+ new methods!
p.ext()                    # "txt"
p.size_human()             # "1.5 KB"
p.ensure_parent().touch()  # Create parent dirs and file
p.copy_to("backup.txt")    # Copy file

Installation

pip install pathlib3

Documentation Contents

• Quick Start Guide
  • Installation
  • Basic Usage
  • Common Tasks
  • Next Steps
  • Need Help?
• API Reference
  • Path Class
  • PurePath3 Class
  • Method Categories
• Examples
  • Basic File Operations
  • Working with JSON
  • Directory Tree Operations
  • File Management
  • Log File Processing
  • File Comparison and Verification
  • Batch Operations
  • Method Chaining
  • Cleanup Operations
  • Data Processing
  • Music tag info
  • Validate File Integrity
  • Handling None Values
  • Get Metadata
  • Send as Email Attachment
  • Image Manipulation

Support

• GitHub: github.com/cumulus13/pathlib3

• Issues: GitHub Issues

• PyPI: pypi.org/project/pathlib3

License

MIT License - see LICENSE file for details.