Metadata-Version: 2.1
Name: frontmatter
Version: 3.0.6
Summary: Extract YAML frontmatter from files and strings.
Home-page: https://github.com/jonbeebe/frontmatter
Author: Jonathan Beebe
Author-email: me@jonbeebe.net
License: UNKNOWN
Description: frontmatter
        ============
        
        A simple Python package for parsing YAML Frontmatter from a text file or string. Written for Python 3, but should also work for Python 2.7.
        
        Usage
        ------
        
        ```
        from frontmatter import Frontmatter
        
        # assuming 'testfile.md' exists
        post = Frontmatter.read_file('testfile.md')
        
        print(post['attributes'], "\n")  # Dictionary
        print(post['body'], "\n")        # String
        print(post['frontmatter'])       # String
        ```
        
        The output would be:
        
        ```
        {'foo': 'bar', 'num': 3, 'list': ['first', 'second', 'third']}
        
        This is the actual post content
        This is a second line
        
        foo: bar
        num: 3
        list:
        - first
        - second
        - third
        ```
        
        In the above example, the contents of **testfile.md** is:
        
        ```
        ---
        foo: bar
        num: 3
        list:
        - first
        - second
        - third
        ---
        
        This is the actual post content
        This is a second line
        ```
        
        LICENSE
        --------
        
        [ISC License](https://en.wikipedia.org/wiki/ISC_license)
        
        
        Copyright (c) 2018, Jonathan Beebe
        
        Permission to use, copy, modify, and/or distribute this software for any
        purpose with or without fee is hereby granted, provided that the above
        copyright notice and this permission notice appear in all copies.
        
        THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        
Keywords: yaml frontmatter front-matter markdown blogging
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
