Fred
/
pigeon_hole
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

readme

This commit is contained in:
Fred Pauchet 2011-09-30 08:18:24 +02:00
parent 18733e69d9
commit e125bbc02b
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README → README.md
View File

@ -10,15 +10,18 @@ How it works
The project is splitted into several files :
* pigeonhole/pigeonhole.py : the one that should be run :)
* setup.py : not used yet (sorry)
* setup.py : not used yet, sorry.
* pigeonhole/config.py : where you should put your configuration.
### config.py ###
The configuration file contains the declaration of three variables :
1. useless_files_extensions : used to clean a folder when the content of this directory (and its subdirectories) is only composed by this kind of files. Do not try to put `*` inside this filter, I don't know the behavior yet...
2. shows_extensions : the files that need to be organized. The `process` method of the `PigeonHole` class won't look for anything else than these filetype (sorry to based the recognition on extensions and not on [http://en.wikipedia.org/wiki/List_of_file_signatures](magic numbers))
2. shows_extensions : the files that need to be organized. The `process` method of the `PigeonHole` class won't look for anything else than these filetype (sorry to based the recognition on extensions and not on [magic numbers](http://en.wikipedia.org/wiki/List_of_file_signatures))
3. shows_dict : used for file that have a 'special name'
(ie. using 'tbbt' while the real name is much much longer)
(ie. using 'tbbt' while the real name that can be found in the destination folder is much much longer)
Unit testing
------------
@ -26,4 +29,4 @@ All tests are located inside the `pigeonhole/tests` directory. To launch them, u
python -m unittest discover
Temporary files and folders are created (and cleaned) to verify that the behavior is going okay.
Temporary files and folders are created (and cleaned) to verify that the file behavior is going okay.