Python's Markdown extension to apply proper English title-casing.
This project use titlecase module under the hood. Transformation is applied on content enclosed in <h1>
to <h6>
HTML tags. Meta-Data extension is supported so that document title can be transformed too.
This package is available on PyPi, so you can install the latest stable release and its dependencies with a simple pip call:
See also pip installation instructions.
Parameter | Default value | Description |
---|---|---|
metadata |
['title', ] |
List of metadata keys to which apply titlecasing. |
Check out latest development branch:
Run unit-tests:
Run PEP8 and Pylint code style checks:
Here is a bunch of rules we're trying to follow regarding stability:
- Patch releases (
0.x.n
→0.x.(n+1)
upgrades) are bug-fix only. These releases must not break anything and keeps backward-compatibility with0.x.*
and0.(x-1).*
series. - Minor releases (
0.n.*
→0.(n+1).0
upgrades) includes any non-bugfix changes. These releases must be backward-compatible with any0.n.*
version but are allowed to drop compatibility with the0.(n-1).*
series and below. - Major releases (
n.*.*
→(n+1).0.0
upgrades) are not planned yet: we're still in beta and the final feature set of the1.0.0
release is not decided yet.
Start from the develop
branch:
Revision should already be set to the next version, so we just need to set the released date in the changelog:
Create a release commit, tag it and merge it back to main
branch:
Push packaging to the test cheeseshop:
Publish packaging to PyPi:
Bump revision back to its development state:
Now if the next revision is no longer bug-fix only:
This software is licensed under the GNU General Public License v2 or later (GPLv2+).