Python package API documentation

[monokal]

It would be great to be able to import fastdupes and use it in our own Python projects, but the documentation is lacking clear guidance.

I can imagine something as friendly as this would become quite a popular package:

import fastdupes

removed = fastdupes.remove(path="/some/path", recursive=True)

print(f"Removed {len(removed)} duplicate files!")

[ssokolow]

To be honest, fastdupes is a low priority for me right now. I have several other much more pressing projects that are in much more dire need of updating and it's been hard fitting in work on them.

(QuickTile needs to be ported to GTK+ 3.x now that the GTK+ 2.x libwnck bindings have been dropped from *buntu, ITAD Importer is flat-out broken for several sites and being written in CoffeeScript is hamstringing fixing it, The support period for Kubuntu 14.04 LTS is about to end and I need to block out time to squash the inevitable bugs from upgrading to 18.04 LTS, etc.)

I'm also probably going to rewrite it in Rust when I get back to it, because, when automated deletion of files is in play, I want stronger compile-time guarantees.

That said, it wouldn't be difficult for me to expose Python bindings if I do that. rust-cpython is great that way so I'll leave this open as a TODO note.