1
0
mirror of https://github.com/arsenetar/dupeguru.git synced 2024-11-17 12:39:02 +00:00
dupeguru/hscommon
Virgil Dupras 10dbfa9b38 Refactoring: Path API compatibility with pathlib
Refactored dupeGuru to make hscommon.path's API a bit close to pathlib's
API. It's not 100% compatible yet, but it's much better than before.

This is more of a hscommon refactoring than a dupeguru one, but since
duepGuru is the main user of Path, it was the driver behind the
refactoring.

This refactoring also see the introduction of @pathify, which ensure
Path arguments. Previously, we were often unsure of whether the caller
of a function was passing a Path or a str. This problem is now solved
and this allows us to remove hscommon.io, an ill-conceived attempt to
solve that same ambiguity problem.

Fixes #235.
2013-11-16 12:06:16 -05:00
..
.tx Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
docs Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
gui Fixed progress under Cocoa which always cancelled the job 2013-08-04 09:11:19 -04:00
locale Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
tests Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00
__init__.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
.gitignore Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
build.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
conflict.py Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00
currency.py Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00
debug.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
desktop.py Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00
geometry.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
LICENSE Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
loc.py Added the --normpo build option 2013-08-03 17:13:24 -04:00
notify.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
path.py Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00
plat.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
pygettext.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
README Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
reg.py Refactoring: Created hscommon.desktop 2013-10-12 13:54:13 -04:00
sphinxgen.py Call sphinx-build from withing Python instead of a subprocess 2013-08-19 17:43:32 -04:00
sqlite.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
testutil.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
trans.py Added the Vietnamese language 2013-08-03 17:36:53 -04:00
util.py Refactoring: Path API compatibility with pathlib 2013-11-16 12:06:16 -05:00

The documentation has to be built with Sphinx. You can get Sphinx at http://sphinx.pocoo.org/

Once you installed it, you can build the documentation with:

cd docs
sphinx-build . ../docs_html

The reason why you have to move in 'docs' is because hscommon.io conflicts with the builtin 'io'
module. The documentation is also available online at http://www.hardcoded.net/docs/hscommon