/tagfs-utils

utility scripts for tagfs

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

tagfs-utils - utilities for tagfs

1) Introduction
2) Requirements
3) Installation
4) Usage
4.1) tag
4.1.1) read Command
4.1.2) append Command
4.1.3) set Command
4.1.4) crename Command
4.2) gmail_to_tags
5) Tests
6) Contact

---------------------------------------------------------------------
Introduction

TODO

---------------------------------------------------------------------
Requirements

* python 2.5, 2.6

---------------------------------------------------------------------
Installation

To install tagfs utils into your home directory type the following:

$ python setup.py install --home ~/.local

If you haven't already extended your local python path then add the following
to your environment configuration script. For example to your .bashrc:

export PYTHONPATH=~/.local/lib/python:$PYTHONPATH

---------------------------------------------------------------------
Usage

This section describes the tagfs utils applications.

---------------------------------------------------------------------
Usage - tag

The tag application is used to view and manage taggings.

The tag application is called like this:
$ tag [target directory] <commands...>

All tag operations are executed on a tagged directory. This is the
application's first parameter. The following parameters are executed commands.
The following sections describe the supported commands.

---------------------------------------------------------------------
Usage - tag - read Command

The read command is used to read values specified below a specific context.

TODO

---------------------------------------------------------------------
Usage - tag - append Command

The append command is used to append taggings to a tagged directory.

TODO

---------------------------------------------------------------------
Usage - tag - set Command

The set command is used to set a single context's value.

TODO

---------------------------------------------------------------------
Usage - tag - crename Command

The crename command is used to rename a context.

$ tag [target directory] crename [old context name] [new context name]

---------------------------------------------------------------------
Usage - gmail_to_tags

First export your gmail contacts using the google CSV format. You can find a
guide for doing this here:
http://mail.google.com/support/bin/answer.py?answer=24911

The downloaded contacts CSV file contains UTF-16 character encoding. Right now
gmail_to_tags can't handle this. So you have to convert the contacts CSV file:

$ iconv --from-code=utf-16 --to-code=utf-8 google.csv > google.utf8.csv

Then you can convert the contacts CSV to a tagfs compatible directory:

$ mkdir contacts
$ gmail_to_tags -o contacts google.utf8.csv

---------------------------------------------------------------------
Tests

You can execute the test cases via the setup.py script in the project's root
directory.

$ python setup.py test

---------------------------------------------------------------------
Contact

* http://wiki.github.com/marook/tagfs
* Markus Peröbner <markus.peroebner@gmail.com>