Metadata-Version: 1.1
Name: orpyste
Version: 2013.05.22
Summary: A tool for reading yet another simple structured textual data files.
Home-page: https://pypi.python.org/pypi/orpyste
Author: Christophe BAL
Author-email: projetmbc@gmail.com
License: UNKNOWN
Download-URL: https://pypi.python.org/pypi/orpyste
Description: **orPyste**, which is an anagram of **pyStore**, has been built so as to work with textual datas with the possibility to write easily this datas in text files.
        
        If you want more informations and examples than thereafter, just take a look at the docstrings.
        
        .. contents:: Table of Contents
        
        
        ========================
        One important dependency
        ========================
        
        This package uses misTool_. **Don't forget to install it !**
        
        
        ===============================
        Which OS can use this package ?
        ===============================
        
        All the modules have been tested under Mac OS, Windows 7 and Linux Ubuntu 12.10 Quantal.
        
        
        =====================
        `Peuf` specifications
        =====================
        
        The datas are strings storing in blocks using indentation. Each block must have a name looking like **nameOfABlock::** and its content must have a higher level of indentation. Each block can contain other blocks or meaningful contents which can be of the following kinds.
        
        1) You can use **key = value** like datas on each lines of the content.
        
        2) You can also use similar **key = value** like datas but with the possibility to write the value on several lines.
        
        3) More generally, you can use **key [SEP] value** like datas on each lines of the content where **[SEP]** can be a separator belonging to a list of personal separators. Like with **key = value**, it is also possible to put each value on several lines.
        
        4) There is also **lines** like datas for texts stored line by line.
        
        5) Finally, you can use **block** like datas for texts on several lines.
        
        
        ======================
        How to use `orPyste` ?
        ======================
        
        The module contains the class **orpyste.reader.Build** which produces an ordered dictionary whose keys are names of the blocks and values are either dictionaries for blocks containing blocks, or one of the following kinds of block values for blocks containing directly datas.
        
        1) For **key = value** like datas, the block value is a dictionary defined naturally with the keys of the datas and their corresponding values.
        
        2) For **key [SEP] value** like datas with personal separators, the block value is a dictionary with keys corresponding to the separators used, and values equal to one dictionary of key value kind.
        
        3) For **lines** like datas, the block value is the list of the lines.
        
        4) Finally, for **block** like datas, the block value is simply a string corresponding to the whole content of the block.
        
        
        ===================
        Log of main changes
        ===================
        
        All the changes, the minor and the major ones, are in the directory `change_log` (all of this is only in french).
        
        
        :2013-05-22: Two new modes allow to work with **key [SEP] value** like datas using different separators **[SEP]** and not only the equal sign.
        
        
        :2013-04-13: One big bug has been fixed : the second level of indentation was ignored in block and line modes.
        
        
        :2013-04-01: First downloadable version of the package.
        
        
        .. _misTool: https://pypi.python.org/pypi/mistool
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Desktop Environment :: File Managers
Requires: mistool
