Github/filetags: Management of simple tags within file names

mirror of https://github.com/novoid/filetags.git synced 2026-02-16 22:04:15 +00:00

Management of simple tags within file names

Find a file

Karl Voit 69fc2980d6 much better screen output when renaming symlinks + sources		2017-08-31 22:10:15 +02:00
tests	symlink originals get tagged as well, if basename matches	2017-08-27 23:59:45 +02:00
filetags.py	much better screen output when renaming symlinks + sources	2017-08-31 22:10:15 +02:00
license.txt	initial commit	2013-05-09 16:56:13 +02:00
README.org	Added the --tagtrees option and some minor improvements	2017-08-28 19:32:41 +02:00

README.org

filetags
Integration Into Common Tools
- Integrating into Geeqie
- Integration into Thunar
Related tools and workflows
How to Thank Me

## Time-stamp: <2017-08-28 19:32:27 vk> ## -- mode: org; coding: utf-8 -- ## This file is best viewed with GNU Emacs Org-mode: http://orgmode.org/

filetags

This Python script adds or removes tags to file names in the following form:

file without time stamp in name -- *tag2*.txt

file name with several tags -- *tag1 tag2*.jpeg

another example file name with multiple example tags -- *fun videos kids*.mpeg

2013-05-09 a file name with ISO date stamp in name -- *tag1*.jpg

201t-05-09T16.17 file name with time stamp -- *tag3*.csv

The script accepts an arbitrary number of files (see your shell for possible length limitations).

Target group: users who are able to use command line tools and who are using tags in file names.
Hosted on github: https://github.com/novoid/filetags

Why

Besides the fact that I am using ISO dates and times in file names (as shown in examples above), I am using tags with file names. To separate tags from the file name, I am using the separator "space dash dash space".

For people familiar with Regular Expressions:

(<ISO date/time stamp>)? <descriptive file name> -- <list of tags separated by spaces>.<file extension>

Tagging files this way requires a file renaming process. Adding (or removing) tag(s) to a set of file results in multiple renaming processes. Despite advanced renaming tools like vidir (from moreutils) it's handy to have a tool that makes adding and removing tags as simple as possible.

You may like to add this tool to your image or file manager of choice. I added mine to geeqie which is my favorite image viewer on GNU/Linux.

Installation

Get it via GitHub or install it via pip: pip install filetags

Usage

./filetags.py --help

usage: ./filetags.py [-h] [-t "STRING WITH TAGS"] [-r] [-i] [-R] [-s] [-f]
                     [--filebrowser PATH_TO_FILEBROWSER] [--tagtrees] [--ln]
                     [--la] [--lu] [--tag-gardening] [-v] [-q] [--version]
                     [FILE [FILE ...]]

This tool adds or removes simple tags to/from file names.

Tags within file names are placed between the actual file name and
the file extension, separated with " -- ". Multiple tags are
separated with " ":
  Update for the Boss -- projectA presentation.pptx
  2013-05-16T15.31.42 Error message -- screenshot projectB.png

This easy to use tag system has a drawback: for tagging a larger
set of files with the same tag, you have to rename each file
separately. With this tool, this only requires one step.

Example usages:
  ./filetags.py --tags="presentation projectA" *.pptx
      … adds the tags "presentation" and "projectA" to all PPTX-files
  ./filetags.py --tags="presentation -projectA" *.pptx
      … adds the tag "presentation" to and removes tag "projectA" from all PPTX-files
  ./filetags.py -i *
      … ask for tag(s) and add them to all files in current folder
  ./filetags.py -r draft *report*
      … removes the tag "draft" from all files containing the word "report"

This tools is looking for (the first) text file named ".filetags" in
current and parent directories. Each line of it is interpreted as a tag
for tag completion.

Verbose description: http://Karl-Voit.at/managing-digital-photographs/

positional arguments:
  FILE                  One or more files to tag

optional arguments:
  -h, --help            show this help message and exit
  -t "STRING WITH TAGS", --tags "STRING WITH TAGS"
                        one or more tags (in quotes, separated by spaces) to
                        add/remove
  -r, --remove, -d, --delete
                        remove tags from (instead of adding to) file name(s)
  -i, --interactive     interactive mode: ask for (a)dding or (r)emoving and
                        name of tag(s)
  -R, --recursive       recursively go through the current directory and all
                        of its subdirectories (for tag-gardening only)
  -s, --dryrun          enable dryrun mode: just simulate what would happen,
                        do not modify files
  -f, --filter          ask for list of tags and generate links in
                        "/home/vk/.filetags_tagfilter" containing symbolic
                        links to all files with matching tags and start the
                        filebrowser
  --filebrowser PATH_TO_FILEBROWSER
                        use this option to override the tool to view/manage
                        files (for --filter; default: geeqie)
  --tagtrees            This generates nested directories in
                        "/home/vk/.filetags_tagfilter" for each combination of
                        tags up to a limit of 2. Can not be used recuresively
                        yet. Please note that this may take long since it
                        relates exponentially to the number of tags involved.
                        See also http://Karl-Voit.at/tagstore/ and
                        http://Karl-Voit.at/tagstore/downloads/Voit2012b.pdf
  --ln, --list-tags-by-number
                        list all file-tags sorted by their number of use
  --la, --list-tags-by-alphabet
                        list all file-tags sorted by their name
  --lu, --list-tags-unknown-to-vocabulary
                        list all file-tags which are found in file names but
                        are not part of .filetags
  --tag-gardening       This is for getting an overview on tags that might
                        require to be renamed (typos, singular/plural, ...).
                        See also http://www.webology.org/2008/v5n3/a58.html
  -v, --verbose         enable verbose mode
  -q, --quiet           enable quiet mode
  --version             display version and exit

:copyright: (c) by Karl Voit <tools@Karl-Voit.at>
:license: GPL v3 or any later version
:URL: https://github.com/novoid/filetag
:bugreports: via github or <tools@Karl-Voit.at>
:version: 2017-08-28
·

Examples:

filetags.py --tags foo a_file_name.txt

… adds tag "foo" such that it results in a_file_name -- foo.txt

filetags.py -i *.jpeg

… interactive mode: asking for list of tags (for the JPEG files) from the user

filetags.py --tags "foo bar" "file name 1.jpg" "file name 2 -- foo.txt" "file name 3 -- bar.csv"

… adds tag "foo" such that it results in …

"file name 1 -- foo bar.jpg"
"file name 2 -- foo bar.txt"
"file name 3 -- bar foo.csv"

filetags.py --remove --tags foo "foo a_file_name -- foo.txt"

… removes tag "foo" such that it results in foo a_file_name.txt

filetags.py --tag-gardening

… prints out a summary of tags in current and sub-folders used and tags that are most likely typos or abandoned

Changelog

Get the most out of filetags: controlled vocabulary `.filetags`

This awesome tool is providing support for controlled vocabularies. When invoked for interactive tagging, it is looking for files named .filetags in the current working directory and its parent directories as well. The first file of this name found is read in. Each line represents one tag. Those tags are used for tag completion.

This is purely great: with tags within .filetags you don't have to enter the tags entrirely: just type the first characters and press TAB (twice to show you all possibilities). You will be amazed how efficiently you are going to tag things! :-)

Of course, you can remove existing tags by prepending a - character to the tag: -tagname. This also works interactively using the tab completion feature.

Mutually exclusive tags

If you enter multiple tags in the same line in .filetags, they are interpreted as mutually exclusive tags. For example, if your .filetags contains the line winter spring summer autumn, filetags replaces any season-tag with the new one. So if you tag the file …

example file -- summer anothertag.txt

… with the tag winter, it gets renamed to …

example file -- winter anothertag.txt

… without having to manually remove the tag summer.

tagtrees

This functions is somewhat sophisticated with regards to the background. If you're really interested in the whole story behind the visualization/navigation of tags using tagtrees, feel free to read my PhD thesis about it on the tagstore webpage. It is surely a piece of work I am proud of and the general chapters of it are written so that the average person is perfectly well able to follow.

In short: this function takes the files of the current directory and generates hierarchies up to level of $maxdepth (by default 2) of all combinations of tags, linking all files according to their tags.

Consider having a file like:

My new car -- car hardware expensive.jpg

Now you generate the tagtrees, you'll find links to this file within sub-directories of ~/.filetags, the default target directory: new/ and hardware/ and expensive/ and new/hardware/ and new/expensive/ and hardware/new/ and so on. You get the idea.

Therefore, within the folder new/expensive/ you will find all files that have at least the tags "new" and "expensive" in any order. This is really cool to have.

Files of the current directory that don't have any tag at all, are linked directly to ~/.filetags so that you can find and tag them easily.

I personally, do use this feature within my image viewer of choice (geeqie). I mapped it to Shift-T because Shift-t is occupied by filetags for tagging of course. So when I am within my image viewer and I press Shift-T, tagtrees of the currently shown images are created. Then an additional image viewer window opens up for me, showing the resulting tagtrees. This way, I can quickly navigate through the tag combinations to easily interactively filter according to tags.

Please note: when you are tagging linked files within the tagtrees with filetags, only the current link gets updated with the new name. All other links to this modified filename within the other directories of the tagtrees gets broken. You have to re-create the tagtrees to update all the links after tagging files.

Bonus: Using tags to specify a sub-set of photographs

You know the problem: got back from Paris and you can not show 937 image files to your friends. It's just too much.

My solution: I tag to define selections. For example, I am using sel for the ultimate cool photographs using filetags, of course.

Within geeqie, I redefined S (usually mapped to "sort manager") to an external shell script (below) which creates a temporary folder (within /tmp/), symbolic links to all photographs of the current folder that contain the tag sel, and start a new instance of geeqie.

In short: after returning from a trip, I mark all "cool" photographs within geeqie, choose t and tag them with sel (described in previous section). For showing only sel images, I just press S in geeqie and instead of 937 photographs, my friends just have to watch the best 50 or so. :-)

The script vksel.sh looks like this:

#!/bin/sh

TMPDIR="/tmp/imageselection"
IMAGEDIR="${1}"
IMAGEVIEWER="geeqie"
FILENAME=$(basename $0)

print_usage()
{
        echo
        echo "usage:   ${FILENAME} <directory>"
        echo
        echo "... starts a image viewer containing files tagged with \"sel\" in the current"
        echo "folder or the folder given as parameter 1."
        echo
}

STARTDIR=`pwd`

if [ "x${IMAGEDIR}" = "x-h" -o "x${IMAGEDIR}" = "x--help" ]; then
    print_usage
    exit 0
fi

if [ "x${IMAGEDIR}" = "x" ]; then
    IMAGEDIR="${STARTDIR}"
fi

if [ ! -d ${IMAGEIDIR} ]; then
    echo
    echo "  Please specify a folder containing the <directory>."
    echo
    print_usage
    exit 1
fi


## remove (old) TMPDIR if exists:
test -d "${TMPDIR}" && rm -rf "${TMPDIR}"

## create fresh TMPDIR
mkdir "${TMPDIR}"
cd "${TMPDIR}"


find "${IMAGEDIR}" -name '* -- *sel*' -print0 | xargs -0 -I {} ln -s {} . --
${IMAGEVIEWER}

cd "${STARTDIR}"

#end

Integration in geeqie is done with $HOME/.config/geeqie/applications/show-sel.desktop

[Desktop Entry]
Name=show-sel
GenericName=show-sel
Comment=
Exec=/home/vk/bin/vksel.sh
Icon=
Terminal=true
Type=Application
Categories=Application;Graphics;
hidden=false
MimeType=image/*;video/*;image/mpo;image/thm
Categories=X-Geeqie;

Integration Into Common Tools

Integrating into Geeqie

I am using geeqie for browsing/presenting image files. After I mark a set of images for adding one or more tags, I just have to press t and I get asked for the tags. After entering the tags and RETURN, the tags are added to the image files. With T I can remove tags accordingly.

Using GNU/Linux, this is quite easy accomplished. The only thing that is not straight forward is the need for a wrapper script. The wrapper script does provide a shell window for entering the tags.

vk-filetags-interactive-adding-wrapper-with-gnome-terminal.sh looks like:

#!/bin/sh

/usr/bin/gnome-terminal \
    --geometry=73x5+330+5  \
    --tab-with-profile=big \
    --hide-menubar \
    -x /home/vk/src/filetags/filetags.py --interactive "${@}"

#end

vk-filetags-interactive-removing-wrapper-with-gnome-terminal.sh looks like:

#!/bin/sh

/usr/bin/gnome-terminal \
    --geometry=73x5+330+5  \
    --tab-with-profile=big \
    --hide-menubar \
    -x /home/vk/src/filetags/filetags.py --interactive --remove "${@}"

#end

In $HOME/.config/geeqie/applications I wrote two desktop files such that geeqie shows the wrapper scripts as external editors to its image files:

$HOME/.config/geeqie/applications/add-tags.desktop looks like:

[Desktop Entry]
Name=filetags
GenericName=filetags
Comment=
Exec=/home/vk/src/misc/vk-filetags-interactive-adding-wrapper-with-gnome-terminal.sh %F
Icon=
Terminal=true
Type=Application
Categories=Application;Graphics;
hidden=false
MimeType=image/*;video/*;image/mpo;image/thm
Categories=X-Geeqie;

$HOME/.config/geeqie/applications/remove-tags.desktop looks like:

[Desktop Entry]
Name=filetags
GenericName=filetags
Comment=
Exec=/home/vk/src/misc/vk-filetags-interactive-removing-wrapper-with-gnome-terminal.sh %F
Icon=
Terminal=true
Type=Application
Categories=Application;Graphics;
hidden=false
MimeType=image/*;video/*;image/mpo;image/thm
Categories=X-Geeqie;

In order to be able to use the keyboard shortcuts t (adding tags) and T (removing tags), you can define them in geeqie:

Edit > Preferences > Preferences … > Keyboard.
Scroll to the bottom of the list.
Double click in the KEY-column of filetags and filetags-remove and choose your desired keyboard shortcut accordingly.

I hope this method is as handy for you as it is for me :-)

Integration into Thunar

Thunar is a popular GNU/Linux file browser for the xfce environment.

Unfortunately, it is rather complicated to add custom commands to Thunar. I found a good description which you might want to follow.

To my disappoinment, even this manual confguration is not stable somehow. From time to time, the IDs of $HOME/.config/Thunar/uca.xml and $HOME/.config/Thunar/accels.scm differ.

For people using Org-mode, I automated the updating process (not the initial adding process) to match IDs again:

Script for checking "tag": do it tag-ID and path in accels.scm match?

#+BEGIN_SRC sh :var myname="tag"
ID=`egrep -A 2 "<name>$myname" $HOME/.config/Thunar/uca.xml | grep unique-id | sed 's#.*<unique-id>##' | sed 's#<.*$##'`
echo "$myname-ID of uca.xml: $ID"
echo "In accels.scm: "`grep -i "$ID" $HOME/.config/Thunar/accels.scm`
#+END_SRC

If they don't match, following script re-writes accels.scm with the current ID:

#+BEGIN_SRC sh :var myname="tag" :var myshortcut="<Alt>t"
ID=`egrep -A 2 "<name>$myname" $HOME/.config/Thunar/uca.xml | grep unique-id | sed 's#.*<unique-id>##' | sed 's#<.*$##'`
echo "appending $myname-ID of uca.xml to accels.scm: $ID"
mv $HOME/.config/Thunar/accels.scm $HOME/.config/Thunar/accels.scm.OLD
grep -v "\"$myshortcut\"" $HOME/.config/Thunar/accels.scm.OLD > $HOME/.config/Thunar/accels.scm
rm $HOME/.config/Thunar/accels.scm.OLD
echo "(gtk_accel_path \"<Actions>/ThunarActions/uca-action-$ID\" \"$myshortcut\")" >> $HOME/.config/Thunar/accels.scm
#+END_SRC

Related tools and workflows

This tool is part of a tool-set which I use to manage my digital files such as photographs. My work-flows are described in this blog posting you might like to read.

In short:

For tagging, please refer to filetags and its documentation.

See date2name for easily adding ISO time-stamps or date-stamps to files.

For easily naming and tagging files within file browsers that allow integration of external tools, see appendfilename (once more) and filetags.

Moving to the archive folders is done using move2archive.

Having tagged photographs gives you many advantages. For example, I automatically choose my desktop background image according to the current season.

Files containing an ISO time/date-stamp gets indexed by the filename-module of Memacs.

How to Thank Me

I'm glad you like my tools. If you want to support me:

Send old-fashioned postcard per snailmail - I love personal feedback!
- see my address
Send feature wishes or improvements as an issue on GitHub
Create issues on GitHub for bugs
Contribute merge requests for bug fixes
Check out my other cool projects on GitHub