mirror of
https://github.com/arsenetar/dupeguru.git
synced 2024-11-17 12:39:02 +00:00
171 lines
6.5 KiB
Markdown
171 lines
6.5 KiB
Markdown
# dupeGuru
|
|
|
|
[dupeGuru][dupeguru] is a cross-platform (Linux and OS X) GUI tool to find duplicate files in
|
|
a system. It's written mostly in Python 3 and has the peculiarity of using
|
|
[multiple GUI toolkits][cross-toolkit], all using the same core Python code. On OS X, the UI layer
|
|
is written in Objective-C and uses Cocoa. On Linux, it's written in Python and uses Qt5.
|
|
|
|
## Current status: People wanted
|
|
|
|
dupeGuru has currently only one maintainer, me. This is a dangerous situation that needs to be
|
|
corrected.
|
|
|
|
The goal is to eventually have another active maintainer, but before we can get there, the project
|
|
needs more contributors. It is very much lacking on that side right now.
|
|
|
|
Whatever your skills, if you are remotely interestested in being a contributor, I'm interested in
|
|
mentoring you. If that's the case, please refer to [the open ticket on the subject][contrib-issue]
|
|
and let's get started.
|
|
|
|
### Slowed development
|
|
|
|
Until I manage to find contributors, I'm slowing the development pace of dupeGuru. I'm not much
|
|
interested in maintaining it alone, I personally have no use for this app (it's been a *loooong*,
|
|
time since I had dupe problems :) )
|
|
|
|
I don't want to let it die, however, so I will still do normal maintainership, that is, issue
|
|
triaging, code review, critical bugfixes, releases management.
|
|
|
|
But anything non-critical, I'm not going to implement it myself because I see every issue as a
|
|
contribution opportunity.
|
|
|
|
### Windows maintainer wanted
|
|
|
|
As [described on my website][nowindows], dupeGuru v4.0 dropped Windows support
|
|
because there isn't anyone to bear the burden of Windows maintenance. If
|
|
you're a Windows developer and are interested in taking this task, [don't
|
|
hesitate to let me know][contrib-issue].
|
|
|
|
### OS X maintainer wanted
|
|
|
|
My Mac Mini is already a couple of years old and is likely to be my last Apple purchase. When it
|
|
dies, I will be unable maintain the OS X version of moneyGuru. I've already stopped paying for the
|
|
Mac Developer membership so I can't sign the apps anymore (in the "official way" I mean. The
|
|
download is still PGP signed) If you're a Mac developer and are interested in taking this task,
|
|
[don't hesitate to let me know][contrib-issue].
|
|
|
|
## Contents of this folder
|
|
|
|
This folder contains the source for dupeGuru. Its documentation is in `help`, but is also
|
|
[available online][documentation] in its built form. Here's how this source tree is organised:
|
|
|
|
* core: Contains the core logic code for dupeGuru. It's Python code.
|
|
* 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.
|
|
* pkg: Skeleton files required to create different packages
|
|
* 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 submodules:
|
|
|
|
* 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
|
|
|
|
### make
|
|
|
|
If you're on linux, you can build the ap for local development with `make`:
|
|
|
|
$ make
|
|
$ make run
|
|
|
|
The `Makefile` is a recent addition, however. You might have to fallback to the legacy build
|
|
scripts.
|
|
|
|
### Legacy build
|
|
|
|
If you're on OS X or that if the `make` method didn't work, you can build dupeGuru with the
|
|
legacy scripts.
|
|
|
|
There's a bootstrap script that will make building 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.
|
|
|
|
### 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.4+][python]
|
|
* Mac OS X: OS X 10.10+ with XCode command line tools.
|
|
* Linux: PyQt5
|
|
|
|
On Ubuntu (14.04+), the apt-get command to install all pre-requisites is:
|
|
|
|
$ apt-get install python3-dev python3-pyqt5 pyqt5-dev-tools python3-venv
|
|
|
|
### OS X and pyenv
|
|
|
|
[pyenv][pyenv] is a popular way to manage multiple python versions. However, be aware that dupeGuru
|
|
will not compile with a pyenv's python unless it's been built with `--enable-framework`. You can do
|
|
this with:
|
|
|
|
$ env PYTHON_CONFIGURE_OPTS="--enable-framework" pyenv install 3.4.3
|
|
|
|
### Setting up the virtual environment
|
|
|
|
*This is done automatically by the bootstrap script. This is a reference in case you need to do it
|
|
manually.*
|
|
|
|
Use Python's built-in `pyvenv` to create a virtual environment in which we're going to install our.
|
|
Python-related dependencies. In that environment, we then install our requirements with pip.
|
|
|
|
For Linux (`--system-site-packages` is to be able to import PyQt):
|
|
|
|
$ pyvenv --system-site-packages env
|
|
$ source env/bin/activate
|
|
$ pip install -r requirements.txt
|
|
|
|
For OS X:
|
|
|
|
$ pyvenv env
|
|
$ source env/bin/activate
|
|
$ pip install -r requirements-osx.txt
|
|
|
|
### Actual building and running
|
|
|
|
With your virtualenv activated, you can build and run dupeGuru with these commands:
|
|
|
|
$ python build.py
|
|
$ python run.py
|
|
|
|
You can also package dupeGuru into an installable package with:
|
|
|
|
$ python package.py
|
|
|
|
|
|
### Generate Ubuntu packages
|
|
|
|
$ bash -c "pyvenv --system-site-packages env && source env/bin/activate && pip install -r requirements.txt && python3 build.py --clean && python3 package.py"
|
|
|
|
### Running tests
|
|
|
|
The complete test suite is run with [Tox 1.7+][tox]. 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`
|
|
|
|
[dupeguru]: http://www.hardcoded.net/dupeguru/
|
|
[cross-toolkit]: http://www.hardcoded.net/articles/cross-toolkit-software
|
|
[contrib-issue]: https://github.com/hsoft/dupeguru/issues/300
|
|
[nowindows]: https://www.hardcoded.net/archive2015#2015-11-01
|
|
[documentation]: http://www.hardcoded.net/dupeguru/help/en/
|
|
[python]: http://www.python.org/
|
|
[pyqt]: http://www.riverbankcomputing.com
|
|
[pyenv]: https://github.com/yyuu/pyenv
|
|
[tox]: https://tox.readthedocs.org/en/latest/
|
|
|