Another portion of fixes.

In this patch, most notable changes are:
- use python3 exclusively for tox
- fix up broken tests
- a couple of style issues fixes here and there

.gitignore

@@ -1,2 +1,8 @@
 __pycache__/
 *.py[cod]
+.coverage
+.tox
+tags
+MANIFEST
+.cache
+pygtktalog.egg-info

MANIFEST.in

@@ -0,0 +1,4 @@
+include setup.py
+include pavement.py
+include paver-minilib.zip
+include pygtktalog/locale/*/*/*.mo

README.rst

@@ -1,180 +1,153 @@
-pyGTKtalog 1.0
-==============
+pyGTKtalog
+==========
 
-pyGTKtalog is Linux/FreeBSD program for indexing CD/DVD or directories on
-filesystem. It is similar to `gtktalog`_ or `gwhere`_ . There is no coincidence
+Pygtktalog is Linux/FreeBSD program for indexing CD, DVD, BR or directories on
+filesystem. It is similar to `gtktalog`_ or `gwhere`_. There is no coincidence
 in name of application, because it's meant to be replacement (in some way) for
 gtktalog, which seems to be dead project for years.
 
-.. image:: /example/main.png
-    :alt: pyGTKtalog main screen
-
-WARNING!
-========
-
-**This version is mostly outdated, full of bugs, and may eat your data!** First
-usable version (this is what you are looking at right now) was completed around
-2009 year, but implementation was done much earlier. During that time GTK2 was
-changed significantly several times, because of that couple of pyGTKtalog
-functionalities goes bad.
-
-The reason for keeping this branch is for history and for GUI to the new engine
-which was rewritten couple of years ago and have only cli tool to manipulate
-DBs.
-
-In other words - pyGTKtalog version on this branch is safe for **view only**
-your catalog database, while it may corrupt database or other files while trying
-to create/update your databases in any way.
-
-You have been warned.
-
-The rest of the README file:
+Current version is 2.0.
 
 FEATURES
-========
+--------
 
-* scan for files in selected media
-* get/generate thumbnails from EXIF and other images
-* stores selected EXIF tags
-* add/edit description and notes
-* fetch comments for images made in `gThumb`_
-* add/remove unlimited images to any file or directory
-* `tagging files`_
-* and more :)
+* Scan for files in selected media
+* Support for grouping files depending on file name (expected patterns in file
+  names)
+* Get/generate thumbnails from EXIF and other images
+* Store selected EXIF tags
+* Add/edit description and notes
+* Fetch comments for images made in `gThumb`_
+* Add/remove unlimited images to any file or directory
+* `Tagging files`_
+* And more :)
 
-Couple of screens showing how it looks like:
+Frontends
+---------
 
-.. image:: /example/tags_images.png
-    :alt: Other tabs - tags and images
+New version of pyGTKtalog was meant to use multiple interfaces.
 
-.. image:: /example/tags_selected.png
-    :alt: Narrow down the files by tags
+#. First for the new incarnation of pyGTKtalog is… command line tool for
+   accessing catalog dbs. With ``cmdcatalog.py`` it's possible to:
 
-.. image:: /example/search.png
-    :alt: Search window and image view
+   * create new catalog
+   * update it
+   * list
+   * find files
+   * fsck (for maintenance for orphaned thumbs/images)
 
-Also, in ``example`` directory you'll find a database ``example.sqlite`` to play
-with.
+#. ``gtktalog.py``. This is written from scratch frontend in pygtk. Still work
+   in progress.
 
-REQUIREMENTS
-============
+Requirements
+------------
 
-pyGTKtalog is written in python with following dependencies:
+pyGTKtalog requires python and following libraries:
 
-* python 2.4 or higher
-* `pygtk 2.10`_ or higher
-* `pysqlite2`_ (unnecessary, if python 2.5 is used)
+* `python 3`_, tested on python 3.6
+* `sqlalchemy 1.2`_ or higher
+* `pygtk 2.24`_ (only for ``gtktalog.py``, will not work with python3)
+* `pillow`_ for image manipulation
+* `exifread`_ for parse EXIF information
 
-Optional modules:
-
-* `PIL`_ for image manipulation
-
-Additional pyGTKtalog uses `pygtkmvc`_ by Roberto Cavada and EXIF module by Gene
-Cash (slightly updatetd to EXIF 2.2 by me) which are included in sources.
+It may work on other (lower) version of libraries, and it should work with
+higher versions of libraries. GTK3 support will follow.
 
 pyGTKtalog extensively uses external programs in unix spirit, however there is
-small possibility of using it Windows (probably with limitations) and quite
-big possibility to run it on other sophisticated unix-like systems (i.e.
+small possibility of using it Windows (probably with limitations) and quite big
+possibility to run it on other sophisticated unix-like systems (i.e.
 BeOS/ZETA/Haiku, QNX or MacOSX).
 
-INSTALLATION
-============
+Programs that are used:
+* ``mencoder`` (provided by `mplayer`_ package)
+* ``montage``, ``convert`` from `ImageMagick`_
+
+For development process following programs are used:
+
+* `gettext`_
+* `intltool`_
+* `nose`_
+* `coverage`_
+* `paver`_
+* `tox`_
+
+INSTALATION
+-----------
 
 You don't have to install it if you don't want to. You can just change current
-directory to pyGTKtalog and simply run:
+directory to pyGTKtalog and simply run::
 
-./pyGTKtalog
+    $ paver run
 
 That's it. Alternatively, if you like to put it in more system wide place, all
 you have to do is:
 
-* put pyGTKtalog directory into your destination of choice (/usr/local/share,
-  /opt or ~/ is typical bet)
-* copy pyGTKtalog shell script to /usr/bin, /usr/local/bin or in
-  other place, where PATH variable is pointing or you feel like.
-* then modify pyGTKtalog line 6 to match right ``pygtktalog.py`` directory
+#. put pyGTKtalog directory into your destination of choice (/usr/local/share,
+   /opt or ~/ is typical bet)
+
+#. copy pyGTKtalog shell script to /usr/bin, /usr/local/bin or in
+   other place, where PATH variable is pointing or you feel like.
+
+#. then modify pyGTKtalog line 6 to match right ``pygtktalog.py`` directory
 
 Then, just run pyGTKtalog script.
 
-TODO
-====
-
-PyGTKtalog is still under heavy development, however there is small chance to
-change structure of catalogs (and if it'll change, there will be transparent
-function to update DB schema).
-
-For version 1.0 there are no features to be done, just bug fixes.
-
-There are still minor aims for versions 1.x to be done:
-- consolidate popup-menus with edit menu
-- add popup menu for directly removing tag from tag cloud
-- implement advanced search
-
-For version 2.0:
-- Export/Import
-- Icon grid in files view
-- command line support: query, adding media to collection etc
-- internationalization
-- export to XLS
-- user defined group of tags (represented by color in cloud tag)
-- hiding specified files - configurable, like dot prefixed, config files and
-  manually selected
-- tests
-- warning about existing image in media directory
-
-Removed:
-- filetypes handling (movies, images, archives, documents etc). Now it have
-  common, unified external "plugin" system - simple text output from command
-  line programs.
-- anime/movie
-		- title
-		- alt title
-		- type (anime movie, movie, anime oav, anime tv series, tv series, etc)
-		- cover/images
-		- genre
-		- lang
-		- sub lang
-		- release date (from - to)
-		- anidb link/imdb link
-  Maybe in future versions. Now text file descriptions/notes and tags have to
-  be enough for good and fast information search.
-
-NOTES
-=====
+Technical details
+-----------------
 
 Catalog file is plain sqlite database (optionally compressed with bzip2). All
-images are stored in ``[CONFIG_PATH]/images`` directory, where ``[CONFIG_PATH]``
-is one of the following location:
-
-- ``$XDG_CONFIG_HOME/pygtktalog``
-- ``$HOME/.pytgtktalog``
-
-Names for images are generated sha512 hash from image file itself. There is
-small possibility for two identical hash for different image files. However, no
-images are overwritten. Thumbnail filename for each image is simply
-concatenation of image filename in images directory and ``_t`` string.
+images are stored in location pointed by db entry in ``config`` table - it is
+assumed, that images directory will be placed within the root directory, where
+the main db lies.
+Generated sha512 hash from image file itself. There is small possibility for two
+identical hash for different image files. However, no images are overwritten.
+Thumbnail filename for each image is simply concatenation of image filename in
+images directory and '_t' string.
 
 There is also converter from old database to new for internal use only. In
 public release there will be no other formats so it will be useless, and
-deleted. There are some issues with converting. All thumbnails will be lost. All
-images without big image will be lost. There are serious changes with
+deleted. There are some issues with converting. All thumbnails will be lost.
+All images without big image will be lost. There are serious changes with
 application design, and I decided, that is better to keep media unpacked on
 disk, instead of pack it every time with save and unpack with open methods. New
 design prevent from deleting any file from media directory (placed in
-``[CONFIG_PATH]/images``). Functionality for exporting images and corresponding
+``~/.pygtktalog/images``). Functionality for exporting images and corresponding
 db file is planned.
 
+
+DEVELOPMENT
+-----------
+
+Several tools has been used to develop pyGTKtalog.
+
+Paver
+^^^^^
+
+I've choose `Paver`_ as make equivalent. Inside main project directory there is
+``pavement.py`` script, which provides several tasks, that can be helpful in a work
+with sources. Paver is also used to generate standard ``setup.py``.
+
 LICENSE
 =======
 
 This work is licensed under the terms of the GNU GPL, version 3. See the LICENCE
 file in top-level directory.
 
+
+.. _coverage: http://nedbatchelder.com/code/coverage/
+.. _exifread: https://github.com/ianare/exif-py
+.. _gettext: http://www.gnu.org/software/gettext/gettext.html
+.. _gthumb: http://gthumb.sourceforge.net
 .. _gtktalog: http://www.nongnu.org/gtktalog/
 .. _gwhere: http://www.gwhere.org/home.php3
-.. _PIL: http://www.pythonware.com/products/pil/index.htm
-.. _pygtk 2.10: http://www.pygtk.org
-.. _pysqlite2: http://pysqlite.org/
-.. _pygtkmvc: http://pygtkmvc.sourceforge.net
-.. _gThumb: http://gthumb.sourceforge.net
-.. _tagging files: http://en.wikipedia.org/wiki/Tag_%28metadata%29
+.. _imagemagick: http://imagemagick.org/script/index.php
+.. _intltool: http://www.gnome.org/
+.. _mplayer: http://mplayerhq.hu
+.. _nose: http://code.google.com/p/python-nose/
+.. _paver: https://pythonhosted.org/paver/
+.. _pillow: https://python-pillow.org/
+.. _pygtk 2.24: http://www.pygtk.org
+.. _python 3: http://www.python.org/
+.. _sqlalchemy 1.2: http://www.sqlalchemy.org
+.. _tagging files: http://en.wikipedia.org/wiki/tag_%28metadata%29
+.. _tox: https://testrun.org/tox

cleanup.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-# remove ~, pyc, pyo files from current directory
-find . -name \*~ -exec rm '{}' ';'
-find . -name \*pyc -exec rm '{}' ';'
-find . -name \*pyo -exec rm '{}' ';'

example/README.rst

@@ -1,9 +0,0 @@
-Example
-=======
-
-Here you can find example database and some screen shots made using this db.
-
-All materials used to prepare sample database and the screen shots were
-downloaded from freely available resources from pages:
-http://www.hd-trailers.net/ and http://www.imdb.com - all rights goes to
-appropriate parties.