Skip to content

Commit 3fdc8f1

Browse files
committed
🔧 chore(project): add license, update README and packaging metadata
1 parent 4001a0c commit 3fdc8f1

5 files changed

Lines changed: 72 additions & 16 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Jannchie
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
# 🚀 TGIT - Tool for Git Interaction Temptation
22

33
[![CodeTime Badge](https://shields.jannchie.com/endpoint?style=social&color=222&url=https%3A%2F%2Fapi.codetime.dev%2Fv3%2Fusers%2Fshield%3Fuid%3D2%26project%3Dtgit)](https://codetime.dev)
4+
[![CI](https://github.com/Jannchie/tgit/actions/workflows/ci.yml/badge.svg)](https://github.com/Jannchie/tgit/actions/workflows/ci.yml)
45
[![codecov](https://codecov.io/gh/Jannchie/tgit/graph/badge.svg?token=YQE0LPE7JX)](https://codecov.io/gh/Jannchie/tgit)
56
[![PyPI version](https://badge.fury.io/py/tgit.svg)](https://badge.fury.io/py/tgit)
67
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
78
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
89

9-
An elegant CLI tool that simplifies and streamlines your Git workflow with AI-powered commit messages, automated changelog generation, and intelligent version management.
10+
TGIT is an AI-powered Git CLI for commit messages, changelog generation, and semantic versioning.
11+
12+
- Generate conventional commits from staged changes
13+
- Build changelogs from commit history
14+
- Bump versions across common project files
15+
- Manage settings from `.tgit.yaml` or an interactive CLI
16+
17+
## 🔗 Links
18+
19+
- Repository: <https://github.com/Jannchie/tgit>
20+
- Issues: <https://github.com/Jannchie/tgit/issues>
21+
- Changelog: <https://github.com/Jannchie/tgit/blob/main/CHANGELOG.md>
1022

1123
## ✨ Features
1224

@@ -43,25 +55,37 @@ An elegant CLI tool that simplifies and streamlines your Git workflow with AI-po
4355

4456
### Installation
4557

58+
```bash
59+
uv tool install tgit
60+
```
61+
62+
```bash
63+
pipx install tgit
64+
```
65+
4666
```bash
4767
pip install tgit
4868
```
4969

5070
### Basic Usage
5171

5272
```bash
53-
# AI-powered commit with automatic message generation
73+
# Configure TGIT
74+
tgit settings
75+
76+
# Generate an AI-powered commit message from staged changes
5477
tgit commit
5578

5679
# Generate changelog for current version
5780
tgit changelog
5881

5982
# Bump version and generate changelog
6083
tgit version
84+
```
6185

6286
### Configuration
6387

64-
The easiest way to configure TGIT is through the interactive settings command:
88+
The recommended way to configure TGIT is through the interactive settings command:
6589

6690
```bash
6791
# Interactive configuration - recommended!
@@ -95,7 +119,7 @@ commit:
95119
96120
```bash
97121
# AI-powered commit
98-
tgit commit
122+
tgit commit
99123

100124
# Breaking change commit
101125
tgit commit --breaking "remove deprecated api"
@@ -151,11 +175,8 @@ tgit settings --show
151175
git clone https://github.com/Jannchie/tgit.git
152176
cd tgit
153177

154-
# Install with uv
155-
uv pip install -e .
156-
157-
# Install development dependencies
158-
uv pip install -e ".[dev]"
178+
# Install dependencies
179+
uv sync
159180
```
160181

161182
### Testing
@@ -176,10 +197,10 @@ uv pip install -e ".[dev]"
176197

177198
```bash
178199
# Run linting
179-
ruff check .
200+
uv run ruff check .
180201

181202
# Run formatting
182-
ruff format .
203+
uv run ruff format .
183204

184205
# Build package
185206
uv build

pyproject.toml

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "tgit"
33
version = "0.29.0"
4-
description = "Tool for Git Interaction Temptation (tgit): An elegant CLI tool that simplifies and streamlines your Git workflow, making version control a breeze."
4+
description = "AI-powered Git CLI for commits, changelogs, and semantic versioning."
55
authors = [{ name = "Jannchie", email = "jannchie@gmail.com" }]
66
dependencies = [
77
"rich>=13.9.4",
@@ -15,17 +15,30 @@ dependencies = [
1515
]
1616
readme = { content-type = "text/markdown", file = "README.md" }
1717
requires-python = ">= 3.11"
18+
license = "MIT"
19+
license-files = ["LICENSE"]
1820
classifiers = [
1921
"Development Status :: 3 - Alpha",
22+
"Environment :: Console",
2023
"Intended Audience :: Developers",
2124
"License :: OSI Approved :: MIT License",
25+
"Operating System :: OS Independent",
2226
"Programming Language :: Python :: 3",
27+
"Programming Language :: Python :: 3.11",
28+
"Programming Language :: Python :: 3.12",
29+
"Programming Language :: Python :: 3.13",
2330
"Topic :: Software Development :: Version Control",
31+
"Topic :: Software Development :: Version Control :: Git",
2432
"Topic :: Utilities",
2533
"Typing :: Typed",
2634
]
27-
keywords = ["git", "tool", "changelog", "version", "commit"]
28-
license = "MIT"
35+
keywords = ["git", "cli", "commit", "changelog", "version", "semver", "conventional-commits", "release"]
36+
37+
[project.urls]
38+
Homepage = "https://github.com/Jannchie/tgit"
39+
Repository = "https://github.com/Jannchie/tgit"
40+
Issues = "https://github.com/Jannchie/tgit/issues"
41+
Changelog = "https://github.com/Jannchie/tgit/blob/main/CHANGELOG.md"
2942

3043
[build-system]
3144
requires = ["hatchling"]
@@ -42,7 +55,7 @@ allow-direct-references = true
4255
packages = ["tgit"]
4356

4457
[project.scripts]
45-
tgit = "tgit:cli.app"
58+
tgit = "tgit.cli:app"
4659

4760
[tool.ruff]
4861
line-length = 140

tgit/py.typed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)