Package: mdx_titlecase
Markdown title-casing extensionPython’s Markdownextension to apply
proper English title-casing.This project usetitlecasemodule
under the hood. Transformation is applied on content enclosed in<h1>to<h6>HTML tags.Meta-Data extensionis supported so
that document title can be transformed too.Stable release:Development:InstallThis package isavailable on PyPi, so you can install the
latest stable release and its dependencies with a simplepipcall:$pipinstallmdx_titlecaseSee alsopip installation instructions.ConfigurationParameterDefault valueDescriptionmetadata['title', ]List of metadata keys to which apply
titlecasing.DevelopmentCheck out latest development branch:$gitclonegit@github.com:kdeldycke/mdx_titlecase.git$cd./mdx_titlecase$python./setup.pydevelopRun unit-tests:$python./setup.pynosetestsRunPEP8andPylintcode style checks:$pipinstallpep8pylint$pep8mdx_titlecase$pylint--rcfile=setup.cfgmdx_titlecaseStability policyHere 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).0upgrades) 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.0upgrades) are not planned yet:
we’re still in beta and the final feature set of the1.0.0release is not
decided yet.Release processStart from thedevelopbranch:$gitclonegit@github.com:kdeldycke/mdx_titlecase.git$gitcheckoutdevelopRevision should already be set to the next version, so we just need to set the
released date in the changelog:$vi./CHANGES.rstCreate a release commit, tag it and merge it back tomasterbranch:$gitadd./mdx_titlecase/__init__.py./CHANGES.rst$gitcommit-m"Release vX.Y.Z"$gittag"vX.Y.Z"$gitpush$gitpush--tags$gitcheckoutmaster$gitpull$gitmerge"vX.Y.Z"$gitpushPush packaging to thetest cheeseshop:$pipinstallwheel$python./setup.pyregister-rtestpypi$python./setup.pyclean$rm-rf./build./dist$python./setup.pysdistbdist_eggbdist_wheelupload-rtestpypiPublish packaging toPyPi:$python./setup.pyregister-rpypi$python./setup.pyclean$rm-rf./build./dist$python./setup.pysdistbdist_eggbdist_wheelupload-rpypiBump revision back to its development state:$pipinstallbumpversion$gitcheckoutdevelop$bumpversion--verbosepatch$gitadd./mdx_titlecase/__init__.py./CHANGES.rst$gitcommit-m"Post release version bump."$gitpushNow if the next revision is no longer bug-fix only:$bumpversion--verboseminor$gitadd./mdx_titlecase/__init__.py./CHANGES.rst$gitcommit-m"Next release no longer bug-fix only. Bump revision."$gitpushLicenseThis software is licensed under theGNU General Public License v2 or later
(GPLv2+).ChangeLog1.2.0 (2018-06-26)Fix plugin initialization.Add Python 3 support.Add defaultisortconfig.Add missing trove classifiers.Activate tests on Python 3.3, 3.4, 3.5, PyPy and PyPy3.Bump Markdown requirement to 2.6.1.1.0 (2015-11-29)Allow title casing of metadata.1.0.1 (2015-11-23)Switch from coveralls.io to codecov.io.1.0.0 (2015-11-23)First public release.0.0.0 (2015-11-22)First commit.