Metadata-Version: 2.1
Name: easy-publish
Version: 0.0.7
Summary: A simple abstraction for publishing files as blog posts.
Home-page: https://github.com/samdixon/easy-publish
Author: Samuel Dixon
Author-email: sdixon@posteo.net
License: MIT
Description: 
        # Easy Publish
        
        Easy publish is a Python library that provides a simple abstraction for publishing text files as blog posts. 
        
        
        ## Installation
        
        Requires: Python >= 3.6
        
        `python3 -m pip install easy-publish`
        
        
        ## Usage
        
        To use easy publish import and call the `generate_posts` function pointing it to the directory your files are located in. The `generate_posts` function returns an object that has two useful data structures: `metadata` and `posts`. `metadata` is a list of metadata about each of your posts(the "Including Markdown" section explains how to include metadata). `posts` is a list of post objects that include the metadata as well as post content.
        
        Below is an example flask app with jinja templating that utilizes easy publish and the `metadata`/`post` objects. While this example uses flask/jinja, any web framework/templating engine should work with easy publish.
        
        #### app.py
        ```
        from flask import Flask, render_template
        from easy_publish import generate_posts
        
        app = Flask(__name__)
        posts = generate_posts("~/my/blogposts")
        
        @app.route("/blog")
        def blog():
          return render_template("blog.html", metadata=posts.metadata)
        
        @app.route("/blog/<p>")
        def blogpost(p):
          return render_template("post.html", post=posts.posts[p])
        ```
        
        #### blog.html
        ```
        {{% for post in metadata %}}
          <li>{{ post.title }}</li>
          <li>{{ post.date }}</li>
          <li>{{ post.tags }}</li>
          <li>{{ post.author }}</li>
        {{% endfor %}}
        ```
        
        #### post.html
        ```
        <h1>{{ post.title }}</h1>
        <h4>{{ post.date }}</h1>
        <h4>{{ post.author }}</h1>
        <p>{{ post.content }}</p>
        ```
        
        ## Including Metadata
        
        Easy publish currently expects text files to have a field at the top denoting the metadata. The field must be in the following format:
        
        ```
        ~
        title: title would go here
        date: date would go here
        tags: tags, would, go, here (comma separated)
        author: author would go here
        ~
        ```
        The parser looks for information in between the ~'s and strips it out into the metadata. It's on the list of TODO's to add different ways to include metadata. 
        
        
        ## Contributing
        
        Currently in heavy development and not a stable interface. Feel free to contribute ideas as issues or as a pull request.
        
        ## License
        
        MIT
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Provides-Extra: dev
