Moved to README.rst.
This commit is contained in:
parent
ec5fa69c4f
commit
660d6bd342
|
@ -0,0 +1 @@
|
|||
*.pyc
|
33
README.md
33
README.md
|
@ -1,33 +0,0 @@
|
|||
sweeper
|
||||
=======
|
||||
|
||||
Find duplicate files and perform action.
|
||||
|
||||
Constructor
|
||||
~~~~~~~~~~~
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
from source::
|
||||
|
||||
python setup.py install
|
||||
|
||||
or from PyPI::
|
||||
|
||||
pip install sweeper
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
this README.rst, code itself, docstrings
|
||||
|
||||
sweeper can be found on github.com at:
|
||||
|
||||
https://github.com/darko-poljak/sweeper
|
||||
|
||||
Tested With
|
||||
===========
|
||||
|
||||
Python2.7.6, Python3.3.3
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
sweeper
|
||||
=======
|
||||
|
||||
Find duplicate files and perform action.
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As module
|
||||
---------
|
||||
|
||||
Print duplicates
|
||||
^^^^^^^^^^^^^^^^
|
||||
from sweeper import file_dups
|
||||
dups = file_dups(['images1', 'images2'])
|
||||
print(dups)
|
||||
|
||||
Remove duplicate files
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
from sweeper import file_dups
|
||||
rm_file_dups(['images'])
|
||||
|
||||
Perform custom action
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
from sweeper import file_dups
|
||||
for files in do_with_file_dups(['images']):
|
||||
for fname in files:
|
||||
print('found duplicte file with name: %s' % fname)
|
||||
|
||||
As script
|
||||
---------
|
||||
|
||||
python sweeper.py --help
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
from source::
|
||||
|
||||
python setup.py install
|
||||
|
||||
or from PyPI::
|
||||
|
||||
pip install sweeper
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
this README.rst, code itself, docstrings
|
||||
|
||||
sweeper can be found on github.com at:
|
||||
|
||||
https://github.com/darko-poljak/sweeper
|
||||
|
||||
Tested With
|
||||
===========
|
||||
|
||||
Python2.7.6, Python3.3.3
|
||||
|
2
setup.py
2
setup.py
|
@ -15,7 +15,7 @@ setup(
|
|||
url='https://github.com/darko-poljak/sweeper',
|
||||
download_url='https://github.com/darko-poljak/sweeper',
|
||||
packages=['sweeper'],
|
||||
long_description=read('README.md'),
|
||||
long_description=read('README.rst'),
|
||||
platforms="OS Independent",
|
||||
install_requires=["docopt"],
|
||||
classifiers=[
|
||||
|
|
Loading…
Reference in New Issue