Merge branch 'release/v0.2.4'

updated doco

README.md

@@ -1,6 +1,6 @@
 Restorething
 ============
-`restorething` is a tool for restoring files from a syncthing verisoning archive. Supply `restorething` the path to the syncthing versioning directory and a date, it will index the available files in the versioning archive and restore files for you.
+`restorething` is a tool for restoring files from a syncthing versioning archive. Supply `restorething` the path to the syncthing versioning directory and a date, it will index the available files in the versioning archive and restore files for you.
 
 `restorething` has multiple restore modes and the ability to filter files and directories.
 
@@ -56,7 +56,7 @@ date | integer | YYYYMMDD | No default value. Field must be supplied by user | D
 -nf | switch | -nf | disabled | Enables indexing archived files every time script is run, by default script will reuse existing DB file for 24 hours
 -nd | switch | -nd | disabled | Enables restoring files that have been deleted or changed due to renaming, by default deleted or renamed files are not included in restore
 -ic | switch | -ic | disabled | Enables restoring files that were marked as conflict files by syncthing and deleted by user, by default conflict files are not restored
--ns | switch | -ns | disabled | Enables no simultation mode, default behaviour is to simulate restore, no simultation mode will copy files from syncthing archive to hard drive
+-ns | switch | -ns | disabled | Enables no simulation mode, default behaviour is to simulate restore, no simulation mode will copy files from syncthing archive to hard drive
 -ff | string | -ff {string} | disabled | Recovers a single version of any files matching the string supplied
 -fd | string | -fd {string} | disabled | Recovers a single version of all files in any DIR matching the string supplied
 -fb | string | -fb {absolute path of file} | disabled | Recovers a single version of a file matching the DIR and Filename
@@ -69,7 +69,7 @@ Default behaviour
 * The default behaviour of the script is to look for the closest file older (before) than supplied date/time. If nothing is found, the script looks for the closest file younger (after) than supplied date/time. The default behaviour can be limited to plus/minus hours by supplying `-pm {hours}` argument or changed to only looking before or after supplied date/time by using the `-b` or `-a` flags, respectively.
 * If no hour is supplied the default time value the script uses is 12pm. This can be changed by using the `-hr {0-24}` argument
 * The script will always simulate a restore by default giving the user an opportunity to review any detected warnings. By supplying the -ns flag, the user can enable the no simulation mode and do an actual restore, no simulation, no undo.
-* The script will create a directory named restore in the diretory the scrpt is being called from and restore all files recursively inside of it
+* The script will create a directory named restore in the directory the script is being called from and restore all files recursively inside of it
 * If no syncthing versioning directory is supplied, the default behaviour is to look in the directory the script is being called from. 
 * All config, log and database files are stored in user's home directory under the directory named .restorething.
 

README.rst

@@ -2,7 +2,7 @@ Restorething
 ============
 
 ``restorething`` is a tool for restoring files from a syncthing
-verisoning archive. Supply ``restorething`` the path to the syncthing
+versioning archive. Supply ``restorething`` the path to the syncthing
 versioning directory and a date, it will index the available files in
 the versioning archive and restore files for you.
 
@@ -144,11 +144,11 @@ Usage
 |           |         |               |                          | are not restored  |
 +-----------+---------+---------------+--------------------------+-------------------+
 | -ns       | switch  | -ns           | disabled                 | Enables no        |
-|           |         |               |                          | simultation mode, |
+|           |         |               |                          | simulation mode,  |
 |           |         |               |                          | default behaviour |
 |           |         |               |                          | is to simulate    |
 |           |         |               |                          | restore, no       |
-|           |         |               |                          | simultation mode  |
+|           |         |               |                          | simulation mode   |
 |           |         |               |                          | will copy files   |
 |           |         |               |                          | from syncthing    |
 |           |         |               |                          | archive to hard   |
@@ -193,8 +193,8 @@ Default behaviour
    an opportunity to review any detected warnings. By supplying the -ns
    flag, the user can enable the no simulation mode and do an actual
    restore, no simulation, no undo.
--  The script will create a directory named restore in the diretory the
-   scrpt is being called from and restore all files recursively inside
+-  The script will create a directory named restore in the directory the
+   script is being called from and restore all files recursively inside
    of it
 -  If no syncthing versioning directory is supplied, the default
    behaviour is to look in the directory the script is being called

RELEASE.md

@@ -0,0 +1,37 @@
+Restorething Release Notes
+==========================
+
+v0.2.4 04/02/2017
+-----------------
+
+* updated doco - fixed typos
+
+v0.2.3 13/01/2017
+-----------------
+
+* Fixed version detection when run as a python module
+
+v0.2.2 12/01/2017
+-----------------
+
+* Added ability to restore all instances of a single file
+* Added user confirmation when overwriting files when restoring, with ability to force overriding without warning
+* Added ability to filter on both directory and file
+* Added storing DB, setting and log files to user home directory
+* Improved CLI date validation and user feedback
+* Improved error handling throughout CLI validation code
+* Improved dbrestore code to be easier to follow and update
+* Updated CLI argument grouping
+* Updated md and rst documentation covering all features
+* Updated user warning code to be reusable
+
+v0.1.0 10/12/2016
+-----------------
+
+* First release features
+* Feature - Nearest file before/after a specific date/time (default behaviour)
+* Feature - Nearest file before a specific date/time
+* Feature - Nearest file after a specific date/time
+* Feature - Filter files with specific string
+* Feature - Filter dir with specific string
+

restorething/_version.py

@@ -1,3 +1,3 @@
 
 
-__version__ = '0.2.3'
+__version__ = '0.2.4'