README.txt

.. contents::

Introduction
============

The codec ``safename`` is meant to rename files to safe filenames.  These
safe filenames have the following properties:

- The safe filenames are valid on most filesystems.
- The safe filenames can be restored to the original filenames.
- The safe filenames are more or less readable.

Examples:

+-----------------+-----------------+
| Input           | Output          |
+=================+=================+
| ``spam``        | ``spam``        |
+-----------------+-----------------+
| ``Spam``        | ``{s}pam``      |
+-----------------+-----------------+
| ``SPAM``        | ``{spam}``      |
+-----------------+-----------------+
| ``spam eggs``   | ``spam_eggs``   |
+-----------------+-----------------+
| ``spam   eggs`` | ``spam___eggs`` |
+-----------------+-----------------+
| ``spàm``        | ``sp(e0)m``     |
+-----------------+-----------------+

The script ``safename`` will rename a list of files, by applying the codec
``safename`` to the current filenames.


Installation
============

Install the distribution from source::

    $ python setup.py install

Or install with ``easy_install``::

    $ easy_install fnord.safename


Codec
=====

Import the package ``fnord.safename`` to register the codec ``safename``::

    >>> import fnord.safename

Now you can encode and decode strings::

    >>> "Spam".encode("safename")
    '{s}pam'
    >>> "{s}pam".decode("safename")
    'Spam'


Script
======

::

    safename [-d|--decode] [-t|--test] [-v|--verbose] [FILE ...]
    safename [-e|--encode] [-t|--test] [-v|--verbose] [FILE ...]

--decode, -d     decode from safe filenames for the given files
--encode, -e     encode to safe filenames for the given files
--recursive, -r  decode or encode filenames recursively
--test, -t       don't rename the files
--verbose, -v    print out every renaming operation


Remarks
=======

Based on the module ``safefilename`` from Torsten Bronger's
`Bobcat project <https://launchpad.net/bobcat>`_.  The implementation is my
own.