Metadata-Version: 2.4
Name: compare-folders
Version: 3.1.0
Summary: Tool to compare two folders
Author: skarfie123
Author-email: rahulpai@rocketmail.com
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
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
Requires-Dist: typer (>=0.17.0,<0.18.0)
Project-URL: Repository, https://github.com/skarfie123/compare-folders
Description-Content-Type: text/markdown

# compare-folders

![PyPI version](https://img.shields.io/pypi/v/compare-folders)
![PyPI downloads](https://img.shields.io/pypi/dm/compare-folders)
![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)

## Installation

It is recommended to install using `pipx`, but you can also use `pip`. See <https://pypi.org/project/pipx/>.

```sh
pipx install compare-folders
```

## Usage

`compare-folders path\to\source path\to\destination`

This will write a markdown file with:

- missing files from the source not in the destination
- extra files in the destination not in the source
- files in both locations with different modification dates

It will also print a table of stats.

Use `-o`/`--output` to override the output filename. If the output file already exists, the resulsts will be appended to the file, unless you specify `--no-append`, in which case the file will be overwritten.

