# Girokmoji
Changelog Generator for Gitmoji enthusiasts
_기록 + Gitmoji_
## Minimum Dependencies
We use minimum dependencies. Currently, only pygit2, which requires no runtime `git` executable, good enough binary
distributions, is used.
## Designed for General Use
### Pipeline as a trigger
Pipelines, such as SCM provided ones (e.g., GitHub Actions), dedicated solutions (e.g., Jenkins) are best when you use
it as a ***"trigger"***.
### Do a single thing
This only generates release note. This project has no interest in versioning scheme, repository scheme (mono/poly war),
even tag order. Just put two tags.
## Basic use case
Clone
```bash
git clone https://github.com/KMilhan/girokmoji.git
```
**Note**: Please change repository url with your repository url. Also, clone with enough depth, so `libgit2` can
traverse to the past tag.
### Installation
If you have `uv`, ***skip***.
Or,
In case you are sure you have isolated environment,
```bash
pip install girokmoji
```
### Generate Release Note
#### with `uv` (recommended, especially for release pipelines)
```bash
uvx --from "girokmoji@latest" girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md
```
#### with isolated `pip`
```bash
python -m girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md
```
or
```bash
girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md
```
## Example
For generated release note, go [EXAMPLE.md](./EXAMPLE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "girokmoji",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "changelog, ci, emoji, git, gitmoji, release, vcs",
"author": null,
"author_email": "Kim Milhan <kimmilhan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d1/fc/1fa8c1a89ba9b6b960ffd57d7328d8926bbba25eff099a2978309785f426/girokmoji-0.5.6.tar.gz",
"platform": null,
"description": "# Girokmoji\n\nChangelog Generator for Gitmoji enthusiasts\n\n_\uae30\ub85d + Gitmoji_\n\n## Minimum Dependencies\n\nWe use minimum dependencies. Currently, only pygit2, which requires no runtime `git` executable, good enough binary\ndistributions, is used.\n\n## Designed for General Use\n\n### Pipeline as a trigger\n\nPipelines, such as SCM provided ones (e.g., GitHub Actions), dedicated solutions (e.g., Jenkins) are best when you use\nit as a ***\"trigger\"***.\n\n### Do a single thing\n\nThis only generates release note. This project has no interest in versioning scheme, repository scheme (mono/poly war),\neven tag order. Just put two tags.\n\n## Basic use case\n\nClone\n\n```bash\ngit clone https://github.com/KMilhan/girokmoji.git\n```\n\n**Note**: Please change repository url with your repository url. Also, clone with enough depth, so `libgit2` can\ntraverse to the past tag.\n\n### Installation\n\nIf you have `uv`, ***skip***.\n\nOr,\nIn case you are sure you have isolated environment,\n\n```bash\npip install girokmoji\n```\n\n### Generate Release Note\n\n#### with `uv` (recommended, especially for release pipelines)\n\n```bash\nuvx --from \"girokmoji@latest\" girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md\n```\n\n#### with isolated `pip`\n\n```bash\npython -m girokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md\n```\n\nor\n\n```bash\ngirokmoji TEST_PROJECT_NAME 2025-02-10 test_repository_dir v0.1.0 v0.5.2 > release_note.md\n```\n\n## Example\n\nFor generated release note, go [EXAMPLE.md](./EXAMPLE.md)\n",
"bugtrack_url": null,
"license": null,
"summary": "Change log creator for gitmoji logs",
"version": "0.5.6",
"project_urls": null,
"split_keywords": [
"changelog",
" ci",
" emoji",
" git",
" gitmoji",
" release",
" vcs"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a90910b57814b38ae2bef197d8cb86995b59d9e95daddee9be0aaa579f50ef7d",
"md5": "c2abdf6013df4eb95e708d630e134b29",
"sha256": "9e8db1a00b8941cd9b1a500d61141c9761a843300a4891ba42854263aa2bcd4a"
},
"downloads": -1,
"filename": "girokmoji-0.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2abdf6013df4eb95e708d630e134b29",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22825,
"upload_time": "2025-02-10T02:53:13",
"upload_time_iso_8601": "2025-02-10T02:53:13.607109Z",
"url": "https://files.pythonhosted.org/packages/a9/09/10b57814b38ae2bef197d8cb86995b59d9e95daddee9be0aaa579f50ef7d/girokmoji-0.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d1fc1fa8c1a89ba9b6b960ffd57d7328d8926bbba25eff099a2978309785f426",
"md5": "403cb24de962587b45671dd8e598a488",
"sha256": "faa145a55427f2ea8bdcd6efde3529cae5ebe511bd66af8340e89563565a9404"
},
"downloads": -1,
"filename": "girokmoji-0.5.6.tar.gz",
"has_sig": false,
"md5_digest": "403cb24de962587b45671dd8e598a488",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 38514,
"upload_time": "2025-02-10T02:53:15",
"upload_time_iso_8601": "2025-02-10T02:53:15.997388Z",
"url": "https://files.pythonhosted.org/packages/d1/fc/1fa8c1a89ba9b6b960ffd57d7328d8926bbba25eff099a2978309785f426/girokmoji-0.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 02:53:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "girokmoji"
}
JSON