ikomet 0.1.1__tar.gz → 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. {ikomet-0.1.1 → ikomet-0.1.2}/PKG-INFO +41 -26
  2. {ikomet-0.1.1 → ikomet-0.1.2}/README.md +40 -25
  3. {ikomet-0.1.1 → ikomet-0.1.2}/pyproject.toml +1 -1
  4. {ikomet-0.1.1 → ikomet-0.1.2}/src/komet/__init__.py +0 -0
  5. {ikomet-0.1.1 → ikomet-0.1.2}/src/komet/main.py +0 -0
{ikomet-0.1.1 → ikomet-0.1.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ikomet
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: AI-powered Conventional Commit message generator using your staged changes
5
5
  Author: ajabri
6
6
  Author-email: abdelalijabri76@gmail.com
@@ -24,6 +24,7 @@ Description-Content-Type: text/markdown
24
24
 
25
25
  Komet is a smart CLI tool that leverages Groq's LLM API to automatically generate professional, [Conventional Commits](https://www.conventionalcommits.org/) formatted commit messages from your staged git changes. Say goodbye to bland commit messages and hello to consistent, meaningful version control history.
26
26
 
27
+ [![PyPI](https://img.shields.io/pypi/v/ikomet)](https://pypi.org/project/ikomet/)
27
28
  [![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
28
29
  [![Poetry](https://img.shields.io/badge/poetry-dependency%20management-blueviolet)](https://python-poetry.org/)
29
30
  [![Groq](https://img.shields.io/badge/powered%20by-Groq%20LLM-orange)](https://groq.com/)
@@ -65,39 +66,45 @@ Use it like this:
65
66
  ### Prerequisites
66
67
 
67
68
  - Python 3.10 or higher
68
- - Poetry (Python dependency management)
69
69
  - Git repository
70
70
  - Groq API key ([Get it here](https://console.groq.com/keys))
71
71
 
72
- ### Install via Poetry
72
+ ### Quick Install from PyPI (Recommended)
73
+
74
+ Install globally using **pipx** (recommended for CLI tools):
73
75
 
74
76
  ```bash
75
- # Clone the repository
76
- git clone https://github.com/ajabrii/Komet.git
77
- cd Komet
77
+ # Install pipx if you don't have it
78
+ python3 -m pip install --user pipx
79
+ python3 -m pipx ensurepath
78
80
 
79
- # Install dependencies
80
- poetry install
81
+ # Install ikomet
82
+ pipx install ikomet
81
83
 
82
- # Set your Groq API key
83
- export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
84
+ # Now use it anywhere!
85
+ komet
86
+ ```
84
87
 
85
- # Run Komet
86
- poetry run komet
88
+ Or install with **pip**:
89
+
90
+ ```bash
91
+ pip install ikomet
87
92
  ```
88
93
 
89
- ### Install as Global Command
94
+ ### Install from Source
95
+
96
+ For development or contributing:
90
97
 
91
98
  ```bash
92
- # Install with pipx (recommended)
93
- pipx install .
99
+ # Clone the repository
100
+ git clone https://github.com/ajabrii/Komet.git
101
+ cd Komet
94
102
 
95
- # Or install globally with poetry
96
- poetry build
97
- pip install dist/komet-0.1.0-py3-none-any.whl
103
+ # Install with poetry
104
+ poetry install
98
105
 
99
- # Now use it anywhere
100
- komet
106
+ # Run Komet
107
+ poetry run komet
101
108
  ```
102
109
 
103
110
  ---
@@ -117,15 +124,23 @@ komet
117
124
  ```
118
125
 
119
126
  3. **Copy and commit** with the suggested message:
120
- ```bash
121
- git commit -m '<generated-message>'
122
- ```
127
+ ```bashGet yours for free at [console.groq.com/keys](https://console.groq.com/keys).
123
128
 
124
- ### Environment Setup
125
-
126
- Komet requires a Groq API key. Set it up once:
129
+ Set it up once:
127
130
 
128
131
  ```bash
132
+ # Linux/macOS - Temporary (current session only)
133
+ export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
134
+
135
+ # Linux/macOS - Permanent (add to ~/.bashrc, ~/.zshrc, or ~/.profile)
136
+ echo 'export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx' >> ~/.bashrc
137
+ source ~/.bashrc
138
+
139
+ # Windows (PowerShell)
140
+ $env:GROQ_API_KEY="gq_xxxxxxxxxxxxxxxx"
141
+
142
+ # Windows - Permanent (System Environment Variables)
143
+ setx GROQ_API_KEY "gq_xxxxxxxxxxxxxxxx"
129
144
  # Temporary (current session only)
130
145
  export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
131
146
 
{ikomet-0.1.1 → ikomet-0.1.2}/README.md RENAMED
@@ -4,6 +4,7 @@
4
4
 
5
5
  Komet is a smart CLI tool that leverages Groq's LLM API to automatically generate professional, [Conventional Commits](https://www.conventionalcommits.org/) formatted commit messages from your staged git changes. Say goodbye to bland commit messages and hello to consistent, meaningful version control history.
6
6
 
7
+ [![PyPI](https://img.shields.io/pypi/v/ikomet)](https://pypi.org/project/ikomet/)
7
8
  [![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
8
9
  [![Poetry](https://img.shields.io/badge/poetry-dependency%20management-blueviolet)](https://python-poetry.org/)
9
10
  [![Groq](https://img.shields.io/badge/powered%20by-Groq%20LLM-orange)](https://groq.com/)
@@ -45,39 +46,45 @@ Use it like this:
45
46
  ### Prerequisites
46
47
 
47
48
  - Python 3.10 or higher
48
- - Poetry (Python dependency management)
49
49
  - Git repository
50
50
  - Groq API key ([Get it here](https://console.groq.com/keys))
51
51
 
52
- ### Install via Poetry
52
+ ### Quick Install from PyPI (Recommended)
53
+
54
+ Install globally using **pipx** (recommended for CLI tools):
53
55
 
54
56
  ```bash
55
- # Clone the repository
56
- git clone https://github.com/ajabrii/Komet.git
57
- cd Komet
57
+ # Install pipx if you don't have it
58
+ python3 -m pip install --user pipx
59
+ python3 -m pipx ensurepath
58
60
 
59
- # Install dependencies
60
- poetry install
61
+ # Install ikomet
62
+ pipx install ikomet
61
63
 
62
- # Set your Groq API key
63
- export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
64
+ # Now use it anywhere!
65
+ komet
66
+ ```
64
67
 
65
- # Run Komet
66
- poetry run komet
68
+ Or install with **pip**:
69
+
70
+ ```bash
71
+ pip install ikomet
67
72
  ```
68
73
 
69
- ### Install as Global Command
74
+ ### Install from Source
75
+
76
+ For development or contributing:
70
77
 
71
78
  ```bash
72
- # Install with pipx (recommended)
73
- pipx install .
79
+ # Clone the repository
80
+ git clone https://github.com/ajabrii/Komet.git
81
+ cd Komet
74
82
 
75
- # Or install globally with poetry
76
- poetry build
77
- pip install dist/komet-0.1.0-py3-none-any.whl
83
+ # Install with poetry
84
+ poetry install
78
85
 
79
- # Now use it anywhere
80
- komet
86
+ # Run Komet
87
+ poetry run komet
81
88
  ```
82
89
 
83
90
  ---
@@ -97,15 +104,23 @@ komet
97
104
  ```
98
105
 
99
106
  3. **Copy and commit** with the suggested message:
100
- ```bash
101
- git commit -m '<generated-message>'
102
- ```
107
+ ```bashGet yours for free at [console.groq.com/keys](https://console.groq.com/keys).
103
108
 
104
- ### Environment Setup
105
-
106
- Komet requires a Groq API key. Set it up once:
109
+ Set it up once:
107
110
 
108
111
  ```bash
112
+ # Linux/macOS - Temporary (current session only)
113
+ export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
114
+
115
+ # Linux/macOS - Permanent (add to ~/.bashrc, ~/.zshrc, or ~/.profile)
116
+ echo 'export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx' >> ~/.bashrc
117
+ source ~/.bashrc
118
+
119
+ # Windows (PowerShell)
120
+ $env:GROQ_API_KEY="gq_xxxxxxxxxxxxxxxx"
121
+
122
+ # Windows - Permanent (System Environment Variables)
123
+ setx GROQ_API_KEY "gq_xxxxxxxxxxxxxxxx"
109
124
  # Temporary (current session only)
110
125
  export GROQ_API_KEY=gq_xxxxxxxxxxxxxxxx
111
126
 
{ikomet-0.1.1 → ikomet-0.1.2}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "ikomet"
3
- version = "0.1.1"
3
+ version = "0.1.2"
4
4
  description = "AI-powered Conventional Commit message generator using your staged changes"
5
5
  authors = ["ajabri <abdelalijabri76@gmail.com>"]
6
6
  readme = "README.md"
{ikomet-0.1.1 → ikomet-0.1.2}/src/komet/__init__.py RENAMED
File without changes
{ikomet-0.1.1 → ikomet-0.1.2}/src/komet/main.py RENAMED
File without changes