Metadata-Version: 2.3
Name: compare-folders
Version: 3.2.0
Summary: Tool to compare two folders
Author: skarfie123
Author-email: skarfie123 <rahulpai@rocketmail.com>
Requires-Dist: typer~=0.20.0
Requires-Python: >=3.10
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

### Programmatically

`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.

### GUI

`compare-folders --gui`

This will open a GUI where you can select the source and destination folders, and then click "Run Comparison" to see the results.

Command line arguments are also supported in GUI mode, so you can specify the source and destination folders, and the output file, when launching the GUI.
