Go to file
Virgil Dupras 64d3c211e6 Updated README 2013-10-20 16:26:16 -04:00
.tx Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
cocoa Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
cocoalib Updated cocoalib 2013-10-20 16:01:59 -04:00
core Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
core_me Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
core_pe Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
core_se Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
debian Updated copyright year to 2013. 2013-04-28 10:35:51 -04:00
help Docs: Fix ugly nulljob repr in method signatures 2013-10-11 12:15:02 -04:00
hscommon Merge branch 'develop' into qt5 2013-10-20 16:02:36 -04:00
images Replaced 'Add' and 'Remove' by + and - icons in the directories dialog under Qt. 2011-01-18 11:07:56 +01:00
locale Updated locs from Transifex 2013-08-04 10:18:38 -04:00
qt Implemented super() inheritance style suggested by PyQt5 2013-10-20 15:53:59 -04:00
qtlib Implemented super() inheritance style suggested by PyQt5 2013-10-20 15:53:59 -04:00
.gitignore Converted repo to Git. 2013-06-21 21:00:52 -04:00
LICENSE Updated copyright year to 2013. 2013-04-28 10:35:51 -04:00
README.md Updated README 2013-10-20 16:26:16 -04:00
bootstrap.sh First Qt5 conversion commit 2013-10-20 15:15:09 -04:00
build.py First Qt5 conversion commit 2013-10-20 15:15:09 -04:00
configure.py Updated copyright year to 2013. 2013-04-28 10:35:51 -04:00
package.py Fixed debian packaging 2013-09-22 09:38:52 -04:00
requirements-extra.txt Added bootstrap script for easy build setup 2013-08-04 15:57:39 -04:00
requirements-osx.txt Removed pluginbuilder usage in build script and replaced it with hscommon functions. 2012-09-10 15:37:57 -04:00
requirements-win.txt Added pip requirement files. 2011-07-11 14:00:03 -04:00
requirements.txt Added bootstrap script for easy build setup 2013-08-04 15:57:39 -04:00

README.md

dupeGuru

This package contains the source for dupeGuru. Its documentation is available online. Here's how this source tree is organised:

  • core: Contains the core logic code for dupeGuru. It's Python code.
  • core_*: Edition-specific-cross-toolkit code written in Python.
  • cocoa: UI code for the Cocoa toolkit. It's Objective-C code.
  • qt: UI code for the Qt toolkit. It's written in Python and uses PyQt.
  • images: Images used by the different UI codebases.
  • debian: Skeleton files required to create a .deb package
  • help: Help document, written for Sphinx.
  • locale: .po files for localisation.

There are also other sub-folder that comes from external repositories and are part of this repo as git subtrees:

  • hscommon: A collection of helpers used across HS applications.
  • cocoalib: A collection of helpers used across Cocoa UI codebases of HS applications.
  • qtlib: A collection of helpers used across Qt UI codebases of HS applications.

How to build dupeGuru from source

The very, very, very easy way

If you're on Linux or Mac, there's a bootstrap script that will make building very, very easy. There might be some things that you need to install manually on your system, but the bootstrap script will tell you when what you need to install. You can run the bootstrap with:

./bootstrap.sh

and follow instructions from the script. You can then ignore the rest of the build documentation.

Prerequisites installation

Prerequisites are installed through pip. However, some of them are not "pip installable" and have to be installed manually.

On Ubuntu (13.10+), the apt-get command to install all pre-requisites is:

$ apt-get install python3-dev python3-pyqt5 pyqt5-dev-tools

On Arch, it's:

$ pacman -S python-pyqt5

Virtualenv setup

Use the built-in pyvenv to setup a virtual environment, and then install pip and run the requirements in it:

$ pyvenv --system-site-packages env
$ source env/bin/activate
$ wget https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py -O - | python
$ easy_install pip

Actual building and running

With your virtualenv activated, you can build and run dupeGuru with these commands:

$ python configure.py
$ python build.py
$ python run.py

You can also package dupeGuru into an installable package with:

$ python package.py