Metadata-Version: 1.1
Name: fptokens
Version: 0.1.0
Summary: A library for tokenisable filename paths
Home-page: https://github.com/florianeinfalt/fptokens
Author: Florian Einfalt
Author-email: info@florianeinfalt.de
License: Apache 2.0
Description: fptokens
        ========
        
        .. image:: https://img.shields.io/pypi/l/fptokens.svg
            :target: https://pypi.python.org/pypi/fptokens
        .. image:: https://img.shields.io/pypi/pyversions/fptokens.svg
            :target: https://pypi.python.org/pypi/fptokens
        .. image:: https://img.shields.io/pypi/v/fptokens.svg
            :target: https://pypi.python.org/pypi/fptokens
        .. image:: https://img.shields.io/pypi/wheel/fptokens.svg
            :target: https://pypi.python.org/pypi/fptokens
        .. image:: https://readthedocs.org/projects/fptokens/badge/?version=latest
            :target: https://readthedocs.org/projects/fptokens/?badge=latest
        .. image:: https://travis-ci.org/florianeinfalt/fptokens.svg?branch=master
            :target: https://travis-ci.org/florianeinfalt/fptokens
        
        A library for tokenisable filename paths
        
        `Full Documentation`_
        
        Installation
        ============
        
        To install ``fptokens``, type:
        
        .. code-block:: bash
        
            $ pip install fptokens
        
        Getting Started
        ===============
        
        To get started with ``fptokens``, type:
        
        .. code-block:: python
        
            >>> import fptokens as fpt
        
        To create a file name, type:
        
        .. code-block:: python
        
            >>> filename = fpt.Filename(root='/Users/demo/Desktop',
                                        folders=['assets', '$colors$'],
                                        base=['asset', '$colors$', '1200px'])
        
        This created a file name with default settings, ``_`` as the separator,
        ``jpg`` as the extension and ``$`` as the escape character for the tokens.
        
        To parse and convert the tokens of the file name to actual tokens, type:
        
        .. code-block:: python
        
            >>> filename.parse()
        
        To get the results of the parsing, type:
        
        .. code-block:: python
        
            >>> print filename.tokens
            >>> [<Token: $color$>]
        
        The list of tokens could now be used to create permutations of the tokenised
        file name for example for batch output of image assets.
        
        ONce tokens have been replaced with real-world data to create permutations,
        the relevant folders can be created by typing:
        
        .. code-block:: python
        
            >>> filename.make()
        
        .. _Full Documentation: http://fptokens.readthedocs.io/en/latest/
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
