跳转到主要内容

Python Markdown的正确标题化。

项目描述

Markdown标题化扩展

Python的Markdown 扩展,用于应用正确的英语标题化。

此项目在底层使用 titlecase 模块。转换应用于从 <h1><h6> HTML 标签的内容。支持 元数据扩展,因此文档标题也可以进行转换。

稳定版本: 上一个发布 软件许可 需求新鲜度 流行度

开发: 单元测试状态 覆盖率状态 代码质量

安装

该软件包可在PyPi上找到,因此您可以使用简单的pip命令安装最新稳定版本及其依赖项。

$ pip install mdx_titlecase

有关安装说明,请参阅pip 安装说明

配置

参数

默认值

描述

metadata

['title', ]

应用标题化的元数据键列表。

开发

检出最新开发分支

$ git clone git@github.com:kdeldycke/mdx_titlecase.git
$ cd ./mdx_titlecase
$ python ./setup.py develop

运行单元测试

$ python ./setup.py nosetests

运行PEP8Pylint代码风格检查

$ pip install pep8 pylint
$ pep8 mdx_titlecase
$ pylint --rcfile=setup.cfg mdx_titlecase

稳定性策略

以下是我们要遵循的一些关于稳定性的规则

  • 补丁版本(0.x.n0.x.(n+1) 升级)仅包含错误修复。这些版本不得破坏任何内容,并保持与 0.x.*0.(x-1).* 系列的向后兼容性。

  • 次要版本(0.n.*0.(n+1).0 升级)包括任何非错误修复更改。这些版本必须与任何 0.n.* 版本向后兼容,但允许与 0.(n-1).* 系列及以下版本不兼容。

  • 主版本(n.*.*(n+1).0.0 升级)尚未计划:我们仍在测试阶段,1.0.0 版本的最终功能集尚未确定。

发布流程

develop 分支开始

$ git clone git@github.com:kdeldycke/mdx_titlecase.git
$ git checkout develop

修订号应已设置为下一个版本,因此我们只需在变更日志中设置发布日期

$ vi ./CHANGES.rst

创建发布提交,标记它并将其合并回 master 分支

$ git add ./mdx_titlecase/__init__.py ./CHANGES.rst
$ git commit -m "Release vX.Y.Z"
$ git tag "vX.Y.Z"
$ git push
$ git push --tags
$ git checkout master
$ git pull
$ git merge "vX.Y.Z"
$ git push

将打包文件推送到测试 cheese shop

$ pip install wheel
$ python ./setup.py register -r testpypi
$ python ./setup.py clean
$ rm -rf ./build ./dist
$ python ./setup.py sdist bdist_egg bdist_wheel upload -r testpypi

将打包文件发布到PyPi

$ python ./setup.py register -r pypi
$ python ./setup.py clean
$ rm -rf ./build ./dist
$ python ./setup.py sdist bdist_egg bdist_wheel upload -r pypi

将修订号回滚到其开发状态

$ pip install bumpversion
$ git checkout develop
$ bumpversion --verbose patch
$ git add ./mdx_titlecase/__init__.py ./CHANGES.rst
$ git commit -m "Post release version bump."
$ git push

现在如果下一个修订号不再仅是错误修复

$ bumpversion --verbose minor
$ git add ./mdx_titlecase/__init__.py ./CHANGES.rst
$ git commit -m "Next release no longer bug-fix only. Bump revision."
$ git push

许可

本软件采用GNU 通用公共许可证 v2 或更高版本(GPLv2+)授权。

变更日志

1.2.0 (2018-06-26)

  • 修复插件初始化。

  • 添加 Python 3 支持。

  • 添加默认 isort 配置。

  • 添加缺少的 trove 类别。

  • 在 Python 3.3、3.4、3.5、PyPy 和 PyPy3 上激活测试。

  • 将 Markdown 要求提升到 2.6。

1.1.0 (2015-11-29)

  • 允许元数据标题化。

1.0.1 (2015-11-23)

  • 从 coveralls.io 切换到 codecov.io。

1.0.0 (2015-11-23)

  • 首次公开发布。

0.0.0 (2015-11-22)

  • 首次提交。

项目详情


下载文件

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

源分布

mdx_titlecase-1.2.0.tar.gz (15.2 kB 查看哈希值)

上传于

构建分布

mdx_titlecase-1.2.0-py3.6.egg (7.4 kB 查看哈希值)

上传于

mdx_titlecase-1.2.0-py3-none-any.whl (7.5 kB 查看哈希值)

上传于 Python 3

由以下提供支持