Go to file
Virgil Dupras e99e2b18e0 Call sphinx-build from withing Python instead of a subprocess 2013-08-19 17:43:32 -04:00
.tx Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
cocoa Fixed SE folder scanning under Cocoa 2013-08-18 21:07:33 -04:00
cocoalib Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
core Fixed folder scanning in SE, which was completely broken 2013-08-18 20:50:31 -04:00
core_me me v6.6.0 2013-08-18 10:16:39 -04:00
core_pe Fix startup crash with PE 2013-08-03 18:01:28 -04:00
core_se se v3.7.1 2013-08-19 16:48:07 -04:00
debian Updated copyright year to 2013. 2013-04-28 10:35:51 -04:00
help se v3.7.1 2013-08-19 16:48:07 -04:00
hscommon Call sphinx-build from withing Python instead of a subprocess 2013-08-19 17:43:32 -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 Fixed 32bit Windows packaging for Python 3.3 2013-08-17 14:48:36 -04:00
qtlib Fixed progress under Qt which always cancelled the job 2013-08-03 21:28:02 -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 Added bootstrap script for easy build setup 2013-08-04 15:57:39 -04:00
bootstrap.sh Tweaked bootstrap script so it works on Ubuntu 2013-08-17 11:32:49 -04:00
build.py Fixed ME's cocoa interface file, which was broken (again) 2013-08-18 11:23:20 -04:00
configure.py Updated copyright year to 2013. 2013-04-28 10:35:51 -04:00
package.py Fixed 32bit Windows packaging for Python 3.3 2013-08-17 14:48:36 -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, the apt-get command to install all pre-requisites is:

$ apt-get install python3-dev python3-pyqt4 pyqt4-dev-tools python3-setuptools

Virtualenv setup

First, you need pip and virtualenv in your system Python install:

$ sudo easy_install pip
$ sudo pip install virtualenv

Then, in dupeGuru's source folder, create a virtual environment and activate it:

$ virtualenv --system-site-packages env
$ source env/bin/activate

Then, you can install pip requirements in your virtualenv:

$ pip install -r requirements-[osx|win].txt

([osx|win] depends, of course, on your platform. On other platforms, just use requirements.txt).

Alternative: pyvenv

If you're on Python 3.3+, you can use the built-in pyvenv instead of virtualenv. pyvenv is pretty much the same thing as virtualenv, except that it doesn't install setuptools and pip, so it has to be installed manually:

$ 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