.tx | ||
cocoa | ||
cocoalib | ||
core | ||
core_me | ||
core_pe | ||
core_se | ||
debian | ||
help | ||
hscommon | ||
images | ||
locale | ||
qt | ||
qtlib | ||
.gitignore | ||
bootstrap.sh | ||
build.py | ||
configure.py | ||
LICENSE | ||
package.py | ||
README.md | ||
requirements-extra.txt | ||
requirements-osx.txt | ||
requirements-win.txt | ||
requirements.txt |
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.
- All systems: Python 3.2+ and setuptools
- Mac OS X: The last XCode to have the 10.6 SDK included.
- Windows: Visual Studio 2008, PyQt 4.7+, cx_Freeze and Advanced Installer (you only need the last two if you want to create an installer)
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