You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Andrew Senetar 549eb7f153
chore: Add vscode launch.json
11 months ago
.github ci: Update to include python 3.11 & pre-commit 11 months ago
.tx chore: Apply whitespace fixes from hooks 11 months ago
.vscode chore: Add vscode launch.json 11 months ago
core fix: Resolve issue with mock object for core test 11 months ago
help chore: Apply whitespace fixes from hooks 11 months ago
hscommon chore: Apply whitespace fixes from hooks 11 months ago
images Finish moving all qtlib py files to qt 2 years ago
locale chore: Remove unused qtlib.pot file 11 months ago
pkg fix: Specify maximum python version for deb 11 months ago
qt Merge pull request #1089 from arsenetar/as/pre-commit 11 months ago
.ctags Add ctags config 8 years ago
.gitignore chore: Add vscode launch.json 11 months ago
.pre-commit-config.yaml chore: Apply whitespace fixes from hooks 11 months ago
.sonarcloud.properties ci: Update to include python 3.11 & pre-commit 11 months ago
CONTRIBUTING.md Fix internal links in CONTRIBUTING.md 2 years ago
CREDITS Remove icon credits from about box 3 years ago
LICENSE chore: Apply whitespace fixes from hooks 11 months ago
MANIFEST.in Move qtlib localization files to top level 2 years ago
Makefile chore: Apply whitespace fixes from hooks 11 months ago
README.md chore: Apply whitespace fixes from hooks 11 months ago
Windows.md chore: Apply whitespace fixes from hooks 11 months ago
build.py Complete removal of qtlib locale files 2 years ago
commitlint.config.js feat: Add pre-commit and commitlint 11 months ago
macos.md chore: Apply whitespace fixes from hooks 11 months ago
package.py Complete removal of qtlib locale files 2 years ago
pyproject.toml chore: Apply whitespace fixes from hooks 11 months ago
requirements-extra.txt chore: Apply whitespace fixes from hooks 11 months ago
requirements.txt Add polib back to requirements.txt 2 years ago
run.py Move create_qsettings() out of preferences 2 years ago
setup.cfg chore: Apply whitespace fixes from hooks 11 months ago
setup.nsi chore: Apply whitespace fixes from hooks 11 months ago
setup.py Minor Updates 2 years ago
tox.ini fix: Correct flake8 config 11 months ago
win_version_info.temp chore: Apply whitespace fixes from hooks 11 months ago

README.md

dupeGuru

dupeGuru is a cross-platform (Linux, OS X, Windows) GUI tool to find duplicate files in a system. It is written mostly in Python 3 and uses qt for the UI.

Current status

Still looking for additional help especially with regards to:

  • OSX maintenance: reproducing bugs, packaging verification.
  • Linux maintenance: reproducing bugs, maintaining PPA repository, Debian package, rpm package.
  • Translations: updating missing strings, transifex project at https://www.transifex.com/voltaicideas/dupeguru-1
  • Documentation: keeping it up-to-date.

Contents of this folder

This folder contains the source for dupeGuru. Its documentation is in help, but is also available online in its built form. Here's how this source tree is organized:

  • core: Contains the core logic code for dupeGuru. It's Python code.
  • qt: UI code for the Qt toolkit. It's written in Python and uses PyQt.
  • images: Images used by the different UI codebases.
  • pkg: Skeleton files required to create different packages
  • help: Help document, written for Sphinx.
  • locale: .po files for localization.
  • hscommon: A collection of helpers used across HS applications.

How to build dupeGuru from source

Windows & macOS specific additional instructions

For windows instructions see the Windows Instructions.

For macos instructions (qt version) see the macOS Instructions.

Prerequisites

System Setup

When running in a linux based environment the following system packages or equivalents are needed to build:

  • python3-pyqt5
  • pyqt5-dev-tools (on some systems, see note)
  • python3-venv (only if using a virtual environment)
  • python3-dev
  • build-essential

Note: On some linux systems pyrcc5 is not put on the path when installing python3-pyqt5, this will cause some issues with the resource files (and icons). These systems should have a respective pyqt5-dev-tools package, which should also be installed. The presence of pyrcc5 can be checked with which pyrcc5. Debian based systems need the extra package, and Arch does not.

To create packages the following are also needed:

  • python3-setuptools
  • debhelper

Building with Make

dupeGuru comes with a makefile that can be used to build and run:

$ make && make run

Building without Make

$ cd <dupeGuru directory>
$ python3 -m venv --system-site-packages ./env
$ source ./env/bin/activate
$ pip install -r requirements.txt
$ python build.py
$ python run.py

Generating Debian/Ubuntu package

To generate packages the extra requirements in requirements-extra.txt must be installed, the steps are as follows:

$ cd <dupeGuru directory>
$ python3 -m venv --system-site-packages ./env
$ source ./env/bin/activate
$ pip install -r requirements.txt -r requirements-extra.txt
$ python build.py --clean
$ python package.py

This can be made a one-liner (once in the directory) as:

$ bash -c "python3 -m venv --system-site-packages env && source env/bin/activate && pip install -r requirements.txt -r requirements-extra.txt && python build.py --clean && python package.py"

Running tests

The complete test suite is run with Tox 1.7+. If you have it installed system-wide, you don't even need to set up a virtualenv. Just cd into the root project folder and run tox.

If you don't have Tox system-wide, install it in your virtualenv with pip install tox and then run tox.

You can also run automated tests without Tox. Extra requirements for running tests are in requirements-extra.txt. So, you can do pip install -r requirements-extra.txt inside your virtualenv and then py.test core hscommon