Skip to main content

将文件发布为博客文章的简单抽象。

项目描述

轻松发布

Easy publish 是一个 Python 库,它为将文本文件发布为博客文章提供了一个简单的抽象。

安装

要求:Python >= 3.6

python3 -m pip install easy-publish

用法

要使用简单的发布导入并调用generate_posts指向文件所在目录的函数。该generate_posts函数返回一个对象,该对象具有两个有用的类变量:metadataposts. metadata是关于您的每个帖子的元数据列表(“​​包含 Markdown”部分解释了如何包含元数据)。posts是包含元数据和帖子内容的帖子对象列表。

下面是一个简单的带有 jinja 模板的烧瓶应用程序,它利用了简单的发布和metadata/post对象。虽然这个例子使用了 flask/jinja,但任何 web 框架/模板引擎都应该使用 easy publish。

应用程序.py

from flask import Flask, render_template
from easy_publish import generate_posts

app = Flask(__name__)
posts = generate_posts("~/path/to/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])

博客.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>

包括元数据

Easy publish 期望文本文件在顶部有一个部分,表示元数据信息。该部分应采用以下格式:

~
title: title would go here
date: date would go here
tags: tags, would, go, here (comma separated)
author: author would go here
~

解析器在 ~ 之间查找信息并将其剥离到元数据中。它在 TODO 的列表中,可以添加不同的方式来包含元数据。

贡献

目前正在大量开发中,并且没有稳定的界面。随意将想法作为问题或作为拉取请求提供。

执照

麻省理工学院

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

easy-publish-0.0.12.tar.gz (7.1 kB 查看哈希

已上传 source

内置分布

easy_publish-0.0.12-py2.py3-none-any.whl (7.4 kB 查看哈希

已上传 py2 py3