PyDuplicateFileManager’s documentation

PyDuplicateFileManager finds duplicated files and directories.

Contents:

Introduction

PyDuplicateFileManager finds duplicated files and directories.

PyDuplicateFileManager is written in Python and released under the MIT license.

Note

This project is still in beta stage, so the API is not finalized yet.

Dependencies

PyDuplicateFileManager is tested to work with Python 3.4 under Gnu/Linux Debian 8 and Windows 7. It should also work with Python 3.X under recent Gnu/Linux and Windows systems. It hasn’t been tested (yet) on MacOSX and BSD systems.

Installation

Gnu/Linux

You can install, upgrade, uninstall PyDuplicateFileManager with these commands (in a terminal):

pip install --pre pydfm
pip install --upgrade pydfm
pip uninstall pydfm

Or, if you have downloaded the PyDuplicateFileManager source code:

python3 setup.py install

Windows

Note:

The following installation procedure has been tested to work with Python 3.4 under Windows 7. It should also work with recent Windows systems.

You can install, upgrade, uninstall PyDuplicateFileManager with these commands (in a command prompt):

py -m pip install --pre pydfm
py -m pip install --upgrade pydfm
py -m pip uninstall pydfm

Or, if you have downloaded the PyDuplicateFileManager source code:

py setup.py install

Example usage

TODO...

Developer’s notes

Source code

The source code is currently available on GitHub under the terms and conditions of the MIT license. Fork away!

Bug reports

To search for bugs or report them, please use the PyDFM Bug Tracker at:

Contribute

PyDFM is written for Python 3.x. Python 2.x is not supported.

The TODO.md file contains the TODO list.

All contributions should at least comply with the following PEPs:

  • PEP8 “Python’s good practices”
  • PEP257 “Docstring Conventions”
  • PEP287 “reStructuredText Docstring Format”

All contribution should be properly documented and tested with unittest and/or doctest.

pylint, pep8 and pyflakes should also be used to check the quality of each module.

Changes

0.1 (2010-02-16)

Initial version.

0.2 (?)

Changes:

  • ?

0.3 (2015-11)

Changes:

  • change the package name (from clonefinder to pydfm)
  • miscellaneous updates and bug fixes

Indices and tables

Credits

Created by Jérémie Decock.

License

PyDuplicateFileManager is provided under the terms and conditions of the MIT license:

The MIT License

Copyright (c) 2010,2011,2015 Jérémie DECOCK (www.jdhp.org)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.