Go to file
Andrew Senetar 2f23f34b91
More updates mainly in preferences
2022-07-08 23:15:59 -05:00
.github Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
.tx Complete removal of qtlib locale files 2022-05-08 19:52:25 -05:00
.vscode Add vscode extension recommendation 2022-03-21 22:27:16 -05:00
core Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
help Update version & changelog for 4.3.1 release 2022-07-07 22:06:06 -05:00
hscommon Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
images Finish moving all qtlib py files to qt 2022-05-08 19:22:08 -05:00
locale Update translations from transifex 2022-07-07 21:57:59 -05:00
pkg Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
qt More updates mainly in preferences 2022-07-08 23:15:59 -05:00
.ctags Add ctags config 2016-06-07 21:36:25 -04:00
.gitignore Add vscode extension recommendation 2022-03-21 22:27:16 -05:00
.sonarcloud.properties Drop Python 3.6 Support 2022-03-15 05:10:41 -05:00
CONTRIBUTING.md Fix internal links in CONTRIBUTING.md 2022-03-21 22:19:58 -05:00
CREDITS Remove icon credits from about box 2020-10-28 02:18:41 +01:00
LICENSE Change license from BSD to GPLv3 2015-01-04 09:59:08 -05:00
MANIFEST.in Move qtlib localization files to top level 2022-05-08 19:23:13 -05:00
Makefile Start PyQt5 -> PyQt6 migration 2022-07-08 21:01:13 -05:00
README.md Start PyQt5 -> PyQt6 migration 2022-07-08 21:01:13 -05:00
Windows.md Start PyQt5 -> PyQt6 migration 2022-07-08 21:01:13 -05:00
build.py Complete removal of qtlib locale files 2022-05-08 19:52:25 -05:00
macos.md Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
package.py Complete removal of qtlib locale files 2022-05-08 19:52:25 -05:00
pyproject.toml Add configuration for isort to pyproject.toml 2022-03-21 00:25:36 -05:00
requirements-extra.txt Start PyQt5 -> PyQt6 migration 2022-07-08 21:01:13 -05:00
requirements.txt Start PyQt5 -> PyQt6 migration 2022-07-08 21:01:13 -05:00
run.py Next batch of qt6 upgrades 2022-07-08 22:17:42 -05:00
setup.cfg More updates for pyqt6 2022-07-08 21:01:24 -05:00
setup.nsi More updates for pyqt6 2022-07-08 21:01:24 -05:00
setup.py Minor Updates 2021-08-26 03:29:24 -05:00
tox.ini Add Python 3.10 to tox.ini 2022-01-25 10:39:52 -06:00
win_version_info.temp Update Windows Build 2019-03-24 21:35:34 -05:00

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-pyqt6
  • python3-venv (only if using a virtual environment)
  • python3-dev
  • build-essential

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