mi4-conventional-commits-lib

Name	mi4-conventional-commits-lib JSON
Version	0.0.6 JSON
	download
home_page	https://github.com/Mi4-Conventional-Commits-Lib/Mi4-Conventional-Commits-Lib
Summary	A conventional commits validation library
upload_time	2025-08-05 16:32:20
maintainer	None
docs_url	None
author	MI4
requires_python	>=3.7
license	None
keywords	conventional-commits validation git commit-message
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

# 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

## 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": "contact@mi4.fr",
    "download_url": "https://files.pythonhosted.org/packages/1b/6f/7925001ee6a9469e84c8e329aedecc9684e3309e214ac4f4c3cca8d78403/mi4_conventional_commits_lib-0.0.6.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\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\n## License\n\nMIT License\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A conventional commits validation library",
    "version": "0.0.6",
    "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": "33401dfdc3dcc4c2f4dbb744694ff5a73ec6f5715b1cbfde7d8df0b165954694",
                "md5": "a2d370e23d3c194b0c9e8bbe41a7efc2",
                "sha256": "6de4e3f81558206a069cf70f659b5783611b1cbd4c5fdfc4ba7158ce3c1dc1e1"
            },
            "downloads": -1,
            "filename": "mi4_conventional_commits_lib-0.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a2d370e23d3c194b0c9e8bbe41a7efc2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 1929,
            "upload_time": "2025-08-05T16:32:19",
            "upload_time_iso_8601": "2025-08-05T16:32:19.144532Z",
            "url": "https://files.pythonhosted.org/packages/33/40/1dfdc3dcc4c2f4dbb744694ff5a73ec6f5715b1cbfde7d8df0b165954694/mi4_conventional_commits_lib-0.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1b6f7925001ee6a9469e84c8e329aedecc9684e3309e214ac4f4c3cca8d78403",
                "md5": "0400cd7d3866c60e3c75b1ef48d22856",
                "sha256": "290fdd05ff9a4e21fd77f7933f8fb7e67ea3578463ce9acaba566d39ca7510a9"
            },
            "downloads": -1,
            "filename": "mi4_conventional_commits_lib-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "0400cd7d3866c60e3c75b1ef48d22856",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 1855,
            "upload_time": "2025-08-05T16:32:20",
            "upload_time_iso_8601": "2025-08-05T16:32:20.359178Z",
            "url": "https://files.pythonhosted.org/packages/1b/6f/7925001ee6a9469e84c8e329aedecc9684e3309e214ac4f4c3cca8d78403/mi4_conventional_commits_lib-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-05 16:32:20",
    "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"
}