# mi4-conventional-commits-lib
A Python library for validating conventional commits.
## Installation
```bash
pip install .
```
## Usage
```python
from mi4_conventional_commits_lib import parseCommit, isCommitValid, buildCommit, getCommitTypes
# Validate a commit
result = validateCommit("feat: new feature (#123)")
print(result) # True
# Parse a commit
parsed = parseCommit("fix(auth)!: fix bug (#456)")
print(parsed) # {'type': 'fix', 'scope': 'auth', ...}
# Build a commit
commit_obj = {
"type": "feat",
"scope": "api",
"breakChange": True,
"description": "new API",
"issue": 789
}
built = buildCommit(commit_obj)
print(built) # "feat(api)!: new API (#789)"
```
## Available Functions
- `parseCommit`: parseCommit function
- `isCommitValid`: isCommitValid function
- `buildCommit`: buildCommit function
- `getCommitTypes`: getCommitTypes function
## License
MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib",
"name": "mi4-conventional-commits-lib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "conventional-commits, validation, git, commit-message",
"author": "MI4",
"author_email": "tom.bedino@mi4.fr",
"download_url": "https://files.pythonhosted.org/packages/a9/82/68ac076b114265b13bcadcba98dc2c9ab6a39326c973292b322f02a94c9c/mi4_conventional_commits_lib-0.0.15.tar.gz",
"platform": null,
"description": "# mi4-conventional-commits-lib\n\nA Python library for validating conventional commits.\n\n## Installation\n\n```bash\npip install .\n```\n\n## Usage\n\n```python\nfrom mi4_conventional_commits_lib import parseCommit, isCommitValid, buildCommit, getCommitTypes\n\n# Validate a commit\nresult = validateCommit(\"feat: new feature (#123)\")\nprint(result) # True\n\n# Parse a commit\nparsed = parseCommit(\"fix(auth)!: fix bug (#456)\")\nprint(parsed) # {'type': 'fix', 'scope': 'auth', ...}\n\n# Build a commit\ncommit_obj = {\n \"type\": \"feat\",\n \"scope\": \"api\",\n \"breakChange\": True,\n \"description\": \"new API\",\n \"issue\": 789\n}\nbuilt = buildCommit(commit_obj)\nprint(built) # \"feat(api)!: new API (#789)\"\n```\n\n## Available Functions\n\n- `parseCommit`: parseCommit function\n- `isCommitValid`: isCommitValid function\n- `buildCommit`: buildCommit function\n- `getCommitTypes`: getCommitTypes function\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": null,
"summary": "A conventional commits validation library",
"version": "0.0.15",
"project_urls": {
"Bug Reports": "https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib/issues",
"Documentation": "https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib#readme",
"Homepage": "https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib",
"Source": "https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib"
},
"split_keywords": [
"conventional-commits",
" validation",
" git",
" commit-message"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4ba5facbc14b7c37231f60b316d9a91941d49d215d118d1f2601a065bfb4d390",
"md5": "a1b403d0978376c2c9cada274302f11e",
"sha256": "c50a1fa2c4141c8bbd0b6e99976cafba317bceb18e51ec8582ef31bcf712dc70"
},
"downloads": -1,
"filename": "mi4_conventional_commits_lib-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1b403d0978376c2c9cada274302f11e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7201,
"upload_time": "2025-09-02T14:44:47",
"upload_time_iso_8601": "2025-09-02T14:44:47.374358Z",
"url": "https://files.pythonhosted.org/packages/4b/a5/facbc14b7c37231f60b316d9a91941d49d215d118d1f2601a065bfb4d390/mi4_conventional_commits_lib-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a98268ac076b114265b13bcadcba98dc2c9ab6a39326c973292b322f02a94c9c",
"md5": "0fd20e2584a63645cb097b66a5df9137",
"sha256": "719a6a9d29c93463b546e30f7cf3a0798afb84893dc81944e72fdaf8eca79637"
},
"downloads": -1,
"filename": "mi4_conventional_commits_lib-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "0fd20e2584a63645cb097b66a5df9137",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7460,
"upload_time": "2025-09-02T14:44:48",
"upload_time_iso_8601": "2025-09-02T14:44:48.405784Z",
"url": "https://files.pythonhosted.org/packages/a9/82/68ac076b114265b13bcadcba98dc2c9ab6a39326c973292b322f02a94c9c/mi4_conventional_commits_lib-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 14:44:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mi4-Conventional-Commits-Lib",
"github_project": "Mi4-Conventional-Commits-Lib",
"github_not_found": true,
"lcname": "mi4-conventional-commits-lib"
}
JSON
