libspec-conventional-commits

Executable libspec specification for the Conventional Commits v1.0.0 specification.

Inherit Commit (or ConvCommit) into any libspec.Feature subclass to endow your features with Conventional Commits specifications, schemas, definitions, and rules.

Installation

uv add libspec-conventional-commits

or

pip install libspec-conventional-commits

Usage

from libspec import Feature
from libspec.conventional_commits import Commit

class MyBaseFeature(Feature, Commit):
    pass

class MyAwesomeFeature(MyBaseFeature):
    pass

You can also combine it with other generic specs like libspec-diataxis:

from libspec import Feature
from libspec.diataxis import Diataxis
from libspec.conventional_commits import Commit

class MyBaseFeature(Feature, Diataxis, Commit):
    pass

class MyAwesomeFeature(MyBaseFeature):
    def tutorial(self):    return "..."
    def how_to(self):      return "..."
    def reference(self):   return "..."
    def explanation(self): return "..."

License

GPL-3.0-or-later