Metadata-Version: 1.1
Name: yamlpage
Version: 2.0.0
Summary: Flatpages based on files with yaml syntax
Home-page: https://github.com/imbolc/yamlpage
Author: Imbolc
Author-email: imbolc@imbolc.name
License: ISC
Description: Install
        -------
            pip install yamlpage
        
        Usage
        -----
            >>> import os
            >>> from yamlpage import YamlPage
            >>> p = YamlPage('./content')
        
        
        Put page
        
            >>> url = '/my/url'
            >>> p.put(url, (
            ...     ('title', 'foo'),
            ...     ('body', 'foo\nbar'),
            ... ))
        
            >>> path = './content/^my^url.yaml'
            >>> print(open(path).read())
            title: foo
            body: |-
              foo
              bar
            <BLANKLINE>
        
        
        Get page
        
            >>> p.get(url) == {'key': '/my/url', 'body': 'foo\nbar', 'title': 'foo'}
            True
        
            >>> p.get('/not/found/') is None
            True
        
        Check if page exists
        
            >>> p.exists(url)
            True
            >>> p.exists('/not/found/')
            False
        
        
        Built in backends
        -----------------
        SingleFolderBackend (default) maps 'my/url' to filename 'my^url.yaml'
        
            >>> p = YamlPage('./content')
            >>> p.put('single/folder/backend', 'data')
            >>> os.path.exists('./content/single^folder^backend.yaml')
            True
        
        MultiFolderBackend maps 'my/url' to filename 'my/url.yaml'
        
            >>> p = YamlPage('./content', backend='MultiFolderBackend')
            >>> p.put('multi/folder/backend', 'data')
            >>> os.path.exists('./content/multi/folder/backend.yaml')
            True
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
