1
0
mirror of https://github.com/arsenetar/dupeguru.git synced 2024-12-08 21:49:02 +00:00
Go to file
Andrew Senetar c57042fdd2
fix: Resolve issue with mock object for core test
Last change introduced a new method on the fs.File object that the test
object did not have.  Add similar method to test object.
2023-01-11 23:20:40 -06:00
.github ci: Update to include python 3.11 & pre-commit 2023-01-09 22:44:10 -06:00
.tx chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
.vscode Add vscode extension recommendation 2022-03-21 22:27:16 -05:00
core fix: Resolve issue with mock object for core test 2023-01-11 23:20:40 -06:00
help chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
hscommon chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
images Finish moving all qtlib py files to qt 2022-05-08 19:22:08 -05:00
locale chore: Remove unused qtlib.pot file 2023-01-09 23:02:19 -06:00
pkg chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
qt Merge pull request #1089 from arsenetar/as/pre-commit 2023-01-09 23:18:13 -06:00
.ctags Add ctags config 2016-06-07 21:36:25 -04:00
.gitignore chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
.pre-commit-config.yaml chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
.sonarcloud.properties ci: Update to include python 3.11 & pre-commit 2023-01-09 22:44:10 -06:00
build.py Complete removal of qtlib locale files 2022-05-08 19:52:25 -05:00
commitlint.config.js feat: Add pre-commit and commitlint 2023-01-09 21:53:22 -06: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 chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
macos.md chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
Makefile chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
MANIFEST.in Move qtlib localization files to top level 2022-05-08 19:23:13 -05:00
package.py Complete removal of qtlib locale files 2022-05-08 19:52:25 -05:00
pyproject.toml chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
README.md chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
requirements-extra.txt chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
requirements.txt Add polib back to requirements.txt 2022-03-27 22:35:34 -05:00
run.py Move create_qsettings() out of preferences 2022-05-08 20:33:31 -05:00
setup.cfg chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
setup.nsi chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
setup.py Minor Updates 2021-08-26 03:29:24 -05:00
tox.ini fix: Correct flake8 config 2023-01-09 22:35:12 -06:00
win_version_info.temp chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00
Windows.md chore: Apply whitespace fixes from hooks 2023-01-09 22:58:08 -06:00

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