Skip to main content

Compare the files between two project folders.

Project description

📁 dircomply - Folder Comparison Tool

dircomply is a lightweight tool to compare files between two directories.It highlights files that differ and those that are unique to each folder.Supports both CLI mode and GUI mode for ease of use.

✅ Features

  • Compare files between two folders
  • Detect differences in file contents
  • List unique files in each folder
  • Supported filetypes are listed later
  • Override or append compare extensions and skipped directories from CLI
  • GUI mode for interactive comparison
  • CLI mode for quick terminal use

💾 Installation

Install dircomply using pip:

pip install dircomply

🧪 Example Usage

Compare two folders via CLI:

dircomply /path/to/folder1 /path/to/folder2

Append one skipped directory and one content extension to the JSON defaults:

dircomply /path/to/folder1 /path/to/folder2 --append_skip_dir dist --append_content_ext .toml

Overwrite skipped directories and content extensions from the JSON defaults:

dircomply /path/to/folder1 /path/to/folder2 --skip_dir .git,build --content_ext .py --content_ext .json

Launch GUI mode:

dircomply

Show version info:

dircomply --version

Display author details:

dircomply --author

📌 Supported CLI Options

Option Description --help, -h Show help message and exit --version, -v Show version number and exit --author, -a Show author name and exit --email, -e Show author email and exit --content_ext VALUE Overwrite JSON content_extensions --append_content_ext VALUE Append to JSON content_extensions --existence_ext VALUE Overwrite JSON existence_extensions --append_existence_ext VALUE Append to JSON existence_extensions --skip_dir VALUE Overwrite JSON skip_dirs --append_skip_dir VALUE Append to JSON skip_dirs

VALUE can be comma-separated or the flag can be repeated. --existance_ext and --append_existance_ext are also accepted as aliases. If no arguments are passed, GUI mode will be launched.

🔎 What Gets Compared?

dircomply compares only files with the following extensions:

        ".txt", ".py", ".bat", ".html", ".ts",".json",".scss",".tcl",".md",
        ".yaml",".yml",".ini",".in",".sh",".gitignore"

Also check below files on existence check rather than the content difference check.

        ".xlsx", ".csv", ".docx",
        ".png",".jpeg",".jpg",".ods",
        ".pdf", ".ico"

The default skipped directories are:

        ".git", ".venv", "nodemodules", ".vscode", "__pycache__", "build"

All other file types are ignored during the comparison.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dircomply-1.2.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dircomply-1.2.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file dircomply-1.2.0.tar.gz.

File metadata

  • Download URL: dircomply-1.2.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for dircomply-1.2.0.tar.gz
Algorithm Hash digest
SHA256 de5ce0e2c058f6a2b07869ea20323703ad2678dd5941ea95c92f01f0df9475fb
MD5 b3663a6765f237561498bf29d2145393
BLAKE2b-256 0338ad7adf0aedf529c8bc6ed7f4d387ec4a0a097481913f8055447e9aec962a

See more details on using hashes here.

File details

Details for the file dircomply-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: dircomply-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for dircomply-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05d11915e549c3c93535d46dacf49583826b29bd4cd08097b9e463638a254ae8
MD5 a71bb4557d19b717cc5f46929e5023ba
BLAKE2b-256 fd3aeccb0f4a4b5257044dd394fb7d1dba2883dfa015b7e890f4aeec326605ac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page