gitrama 1.0.0__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.
- gitrama-1.0.0/LICENSE +18 -0
- gitrama-1.0.0/PKG-INFO +400 -0
- gitrama-1.0.0/README.md +342 -0
- gitrama-1.0.0/gitrama/__init__.py +13 -0
- gitrama-1.0.0/gitrama/ai_client.py +428 -0
- gitrama-1.0.0/gitrama/chat_client.py +698 -0
- gitrama-1.0.0/gitrama/cli.py +738 -0
- gitrama-1.0.0/gitrama/config.py +153 -0
- gitrama-1.0.0/gitrama/git_utils.py +472 -0
- gitrama-1.0.0/gitrama/git_wrapper.py +479 -0
- gitrama-1.0.0/gitrama/init.py +10 -0
- gitrama-1.0.0/gitrama/setup_wizard.py +255 -0
- gitrama-1.0.0/gitrama/streams.py +341 -0
- gitrama-1.0.0/gitrama.egg-info/PKG-INFO +400 -0
- gitrama-1.0.0/gitrama.egg-info/SOURCES.txt +22 -0
- gitrama-1.0.0/gitrama.egg-info/dependency_links.txt +1 -0
- gitrama-1.0.0/gitrama.egg-info/entry_points.txt +3 -0
- gitrama-1.0.0/gitrama.egg-info/not-zip-safe +1 -0
- gitrama-1.0.0/gitrama.egg-info/requires.txt +4 -0
- gitrama-1.0.0/gitrama.egg-info/top_level.txt +1 -0
- gitrama-1.0.0/pyproject.toml +60 -0
- gitrama-1.0.0/setup.cfg +4 -0
- gitrama-1.0.0/setup.py +86 -0
- gitrama-1.0.0/tests/test_basic.py +503 -0
gitrama-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/*************************************************************************
|
|
2
|
+
*
|
|
3
|
+
* GITRAMA CONFIDENTIAL
|
|
4
|
+
* __________________
|
|
5
|
+
*
|
|
6
|
+
* [2026] - [PRESENT] Gitrama LLC
|
|
7
|
+
* All Rights Reserved.
|
|
8
|
+
*
|
|
9
|
+
* NOTICE: All information contained herein is, and remains
|
|
10
|
+
* the property of Gitrama LLC and its suppliers,
|
|
11
|
+
* if any. The intellectual and technical concepts contained
|
|
12
|
+
* herein are proprietary to Gitrama LLC
|
|
13
|
+
* and its suppliers and may be covered by U.S. and Foreign Patents,
|
|
14
|
+
* patents in process, and are protected by trade secret or copyright law.
|
|
15
|
+
* Dissemination of this information or reproduction of this material
|
|
16
|
+
* is strictly forbidden unless prior written permission is obtained
|
|
17
|
+
* from Gitrama LLC.
|
|
18
|
+
*/
|
gitrama-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,400 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: gitrama
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: AI-powered Git workflow automation β smarter commits, branches, PRs, and repo chat
|
|
5
|
+
Home-page: https://gitrama.ai
|
|
6
|
+
Author: Alfonso Harding
|
|
7
|
+
Author-email: Alfonso Harding <contact@gitrama.ai>
|
|
8
|
+
License: /*************************************************************************
|
|
9
|
+
*
|
|
10
|
+
* GITRAMA CONFIDENTIAL
|
|
11
|
+
* __________________
|
|
12
|
+
*
|
|
13
|
+
* [2026] - [PRESENT] Gitrama LLC
|
|
14
|
+
* All Rights Reserved.
|
|
15
|
+
*
|
|
16
|
+
* NOTICE: All information contained herein is, and remains
|
|
17
|
+
* the property of Gitrama LLC and its suppliers,
|
|
18
|
+
* if any. The intellectual and technical concepts contained
|
|
19
|
+
* herein are proprietary to Gitrama LLC
|
|
20
|
+
* and its suppliers and may be covered by U.S. and Foreign Patents,
|
|
21
|
+
* patents in process, and are protected by trade secret or copyright law.
|
|
22
|
+
* Dissemination of this information or reproduction of this material
|
|
23
|
+
* is strictly forbidden unless prior written permission is obtained
|
|
24
|
+
* from Gitrama LLC.
|
|
25
|
+
*/
|
|
26
|
+
Project-URL: Homepage, https://gitrama.ai
|
|
27
|
+
Project-URL: Documentation, https://gitrama.ai/docs_v4.html
|
|
28
|
+
Project-URL: Bug Reports, https://github.com/ahmaxdev/gitrama-cli/issues
|
|
29
|
+
Project-URL: Source, https://github.com/ahmaxdev/gitrama-cli
|
|
30
|
+
Project-URL: Changelog, https://github.com/ahmaxdev/gitrama-cli/releases
|
|
31
|
+
Keywords: git,ai,automation,cli,workflow,developer-tools,commit,branch,pull-request,productivity,openai,anthropic,llm,askgit
|
|
32
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
33
|
+
Classifier: Intended Audience :: Developers
|
|
34
|
+
Classifier: Topic :: Software Development :: Version Control :: Git
|
|
35
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
36
|
+
Classifier: Topic :: Utilities
|
|
37
|
+
Classifier: Programming Language :: Python :: 3
|
|
38
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
41
|
+
Classifier: Operating System :: OS Independent
|
|
42
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
43
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
44
|
+
Classifier: Operating System :: MacOS
|
|
45
|
+
Classifier: Environment :: Console
|
|
46
|
+
Classifier: Natural Language :: English
|
|
47
|
+
Requires-Python: >=3.11
|
|
48
|
+
Description-Content-Type: text/markdown
|
|
49
|
+
License-File: LICENSE
|
|
50
|
+
Requires-Dist: typer>=0.9.0
|
|
51
|
+
Requires-Dist: rich>=13.0.0
|
|
52
|
+
Requires-Dist: requests>=2.31.0
|
|
53
|
+
Requires-Dist: pyperclip>=1.8.2
|
|
54
|
+
Dynamic: author
|
|
55
|
+
Dynamic: home-page
|
|
56
|
+
Dynamic: license-file
|
|
57
|
+
Dynamic: requires-python
|
|
58
|
+
|
|
59
|
+
# Gitrama πΏ
|
|
60
|
+
|
|
61
|
+
> **AI-Powered Git Workflow Automation**
|
|
62
|
+
> Replace `git` with `gtr` β your AI-enhanced Git CLI that writes commit messages, names branches, generates PRs, and manages your workflow context.
|
|
63
|
+
|
|
64
|
+
<div align="center">
|
|
65
|
+
|
|
66
|
+

|
|
67
|
+

|
|
68
|
+

|
|
69
|
+

|
|
70
|
+
|
|
71
|
+
</div>
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## β¨ What is Gitrama?
|
|
76
|
+
|
|
77
|
+
Gitrama is a drop-in replacement for the `git` CLI β powered by AI. Every command you know from git works with `gtr`, but with AI superpowers built in:
|
|
78
|
+
|
|
79
|
+
- π€ **AI commit messages** β never write `git commit -m "fix stuff"` again
|
|
80
|
+
- πΏ **AI branch names** β conventional, clean, generated from plain English
|
|
81
|
+
- π **AI PR descriptions** β professional pull requests in seconds
|
|
82
|
+
- π **AI status interpretation** β tells you what to do next, not just what changed
|
|
83
|
+
- π **Streams** β switch between hotfix, wip, and experiment contexts without stashing
|
|
84
|
+
- π§ **Full git wrapper** β `gtr push`, `gtr pull`, `gtr log`, `gtr diff` and more
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## π Quick Start
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
# Install
|
|
92
|
+
git clone https://github.com/ahmaxdev/gitrama-cli.git
|
|
93
|
+
cd gitrama-cli
|
|
94
|
+
pip install -e .
|
|
95
|
+
|
|
96
|
+
# Configure your AI provider
|
|
97
|
+
gtr setup
|
|
98
|
+
|
|
99
|
+
# The new git workflow
|
|
100
|
+
gtr status # See what changed + AI suggestion
|
|
101
|
+
gtr add # Stage files
|
|
102
|
+
gtr commit # AI-generated commit message
|
|
103
|
+
gtr push # Push to remote
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## π¦ Installation
|
|
109
|
+
|
|
110
|
+
### Requirements
|
|
111
|
+
|
|
112
|
+
- Python 3.11+
|
|
113
|
+
- Git 2.0+
|
|
114
|
+
- An AI provider API key (Anthropic, OpenAI, or Ollama)
|
|
115
|
+
|
|
116
|
+
### Install from Source
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
git clone https://github.com/ahmaxdev/gitrama-cli.git
|
|
120
|
+
cd gitrama-cli
|
|
121
|
+
|
|
122
|
+
# Create virtual environment
|
|
123
|
+
python -m venv venv
|
|
124
|
+
|
|
125
|
+
# Activate (Windows)
|
|
126
|
+
venv\Scripts\activate
|
|
127
|
+
|
|
128
|
+
# Activate (macOS/Linux)
|
|
129
|
+
source venv/bin/activate
|
|
130
|
+
|
|
131
|
+
# Install
|
|
132
|
+
pip install -e .
|
|
133
|
+
|
|
134
|
+
# Verify
|
|
135
|
+
gtr --version
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Install from PyPI *(coming soon)*
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
pip install gitrama
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## βοΈ Configuration
|
|
147
|
+
|
|
148
|
+
### Setup Wizard
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
gtr setup
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
The setup wizard walks you through configuring your AI provider interactively.
|
|
155
|
+
|
|
156
|
+
### Manual Configuration
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
# Set provider (automatically updates API URL)
|
|
160
|
+
gtr config set provider anthropic # or openai | ollama | gitrama
|
|
161
|
+
|
|
162
|
+
# Set your API key
|
|
163
|
+
gtr config set api_key sk-ant-...
|
|
164
|
+
|
|
165
|
+
# Set model (optional)
|
|
166
|
+
gtr config set model claude-sonnet-4-6
|
|
167
|
+
|
|
168
|
+
# View all settings
|
|
169
|
+
gtr config list
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Supported Providers
|
|
173
|
+
|
|
174
|
+
| Provider | Description | API Key Required |
|
|
175
|
+
|----------|-------------|-----------------|
|
|
176
|
+
| `anthropic` | Claude models (recommended) | Yes |
|
|
177
|
+
| `openai` | GPT models | Yes |
|
|
178
|
+
| `ollama` | Local models (free, private) | No |
|
|
179
|
+
| `gitrama` | Gitrama hosted server | No |
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## π Commands
|
|
184
|
+
|
|
185
|
+
### AI Commands
|
|
186
|
+
|
|
187
|
+
| Command | Description |
|
|
188
|
+
|---------|-------------|
|
|
189
|
+
| `gtr commit` | Generate AI commit message from staged changes |
|
|
190
|
+
| `gtr branch "description"` | Generate AI branch name and create branch |
|
|
191
|
+
| `gtr pr` | Generate AI pull request title and description |
|
|
192
|
+
| `gtr summary` | Quick summary of staged changes |
|
|
193
|
+
|
|
194
|
+
### Git Wrapper Commands
|
|
195
|
+
|
|
196
|
+
| Command | Description |
|
|
197
|
+
|---------|-------------|
|
|
198
|
+
| `gtr add [files]` | Stage files (default: all) |
|
|
199
|
+
| `gtr status` | Working tree status + AI suggestion |
|
|
200
|
+
| `gtr push` | Push to remote |
|
|
201
|
+
| `gtr pull` | Pull with AI summary of changes |
|
|
202
|
+
| `gtr fetch` | Fetch remote changes |
|
|
203
|
+
| `gtr log` | Commit history with optional AI summary |
|
|
204
|
+
| `gtr diff` | Show changes with AI explanation |
|
|
205
|
+
| `gtr merge <branch>` | Merge with confirmation guard |
|
|
206
|
+
| `gtr checkout <branch>` | Switch branches |
|
|
207
|
+
| `gtr stash [push\|pop\|list\|drop]` | Stash with AI labels |
|
|
208
|
+
| `gtr reset` | Reset with safety confirmation |
|
|
209
|
+
| `gtr revert` | Revert commit safely |
|
|
210
|
+
|
|
211
|
+
### Stream Commands
|
|
212
|
+
|
|
213
|
+
| Command | Description |
|
|
214
|
+
|---------|-------------|
|
|
215
|
+
| `gtr stream list` | Show all streams |
|
|
216
|
+
| `gtr stream switch <name>` | Switch to a stream |
|
|
217
|
+
| `gtr stream create <name>` | Create custom stream |
|
|
218
|
+
| `gtr stream merge <branch>` | Merge stream into target branch |
|
|
219
|
+
| `gtr stream status` | Detailed stream status |
|
|
220
|
+
| `gtr stream delete <name>` | Delete custom stream |
|
|
221
|
+
|
|
222
|
+
### Utility Commands
|
|
223
|
+
|
|
224
|
+
| Command | Description |
|
|
225
|
+
|---------|-------------|
|
|
226
|
+
| `gtr health` | Check AI server status |
|
|
227
|
+
| `gtr config list` | Show all configuration |
|
|
228
|
+
| `gtr setup` | Interactive setup wizard |
|
|
229
|
+
| `gtr tips` | Show tips and best practices |
|
|
230
|
+
| `gtr welcome` | Show welcome banner |
|
|
231
|
+
| `gtr version` | Show version info |
|
|
232
|
+
|
|
233
|
+
### Shortcuts
|
|
234
|
+
|
|
235
|
+
| Shortcut | Full Command |
|
|
236
|
+
|----------|-------------|
|
|
237
|
+
| `gtr c` | `gtr commit` |
|
|
238
|
+
| `gtr b` | `gtr branch` |
|
|
239
|
+
| `gtr h` | `gtr health` |
|
|
240
|
+
| `gtr s` | `gtr stream` |
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## π Streams
|
|
245
|
+
|
|
246
|
+
Streams let you switch between work contexts instantly β no manual stashing required.
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
# Working on a feature
|
|
250
|
+
gtr stream switch wip
|
|
251
|
+
gtr branch "Add user dashboard"
|
|
252
|
+
# ... make changes, commit ...
|
|
253
|
+
|
|
254
|
+
# URGENT: Production bug!
|
|
255
|
+
gtr stream switch hotfix
|
|
256
|
+
# Your wip work is saved automatically
|
|
257
|
+
gtr branch "Fix payment crash"
|
|
258
|
+
gtr commit
|
|
259
|
+
gtr push
|
|
260
|
+
|
|
261
|
+
# Back to feature work
|
|
262
|
+
gtr stream switch wip
|
|
263
|
+
# Your dashboard work is restored!
|
|
264
|
+
|
|
265
|
+
# Merge hotfix when done
|
|
266
|
+
gtr stream merge main
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Default Streams
|
|
270
|
+
|
|
271
|
+
| Stream | Purpose |
|
|
272
|
+
|--------|---------|
|
|
273
|
+
| `wip` | Work in Progress β main feature work |
|
|
274
|
+
| `hotfix` | Urgent bug fixes and patches |
|
|
275
|
+
| `review` | Code review feedback and changes |
|
|
276
|
+
| `experiment` | Try new ideas safely |
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## π‘ Real-World Workflow
|
|
281
|
+
|
|
282
|
+
```bash
|
|
283
|
+
# Start your day
|
|
284
|
+
gtr status # AI tells you where you left off
|
|
285
|
+
|
|
286
|
+
# Create a feature branch
|
|
287
|
+
gtr branch "Add OAuth login" # β feat/add-oauth-login
|
|
288
|
+
|
|
289
|
+
# Make changes, then commit
|
|
290
|
+
gtr add auth.py login.py
|
|
291
|
+
gtr commit # β feat(auth): add OAuth login with Google provider
|
|
292
|
+
|
|
293
|
+
# Generate PR when ready
|
|
294
|
+
gtr pr # Full PR description copied to clipboard
|
|
295
|
+
|
|
296
|
+
# Push and merge
|
|
297
|
+
gtr push
|
|
298
|
+
gtr stream merge main
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
## π§ Examples
|
|
304
|
+
|
|
305
|
+
### AI Commit Message
|
|
306
|
+
|
|
307
|
+
```bash
|
|
308
|
+
$ gtr commit
|
|
309
|
+
π Found 3 file(s) staged
|
|
310
|
+
π€ Generating commit message...
|
|
311
|
+
|
|
312
|
+
β¨ Generated message:
|
|
313
|
+
feat(auth): add JWT-based user authentication with refresh tokens
|
|
314
|
+
|
|
315
|
+
Use this message? [Y/n]: y
|
|
316
|
+
β
π Commit created successfully!
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### AI Status Suggestion
|
|
320
|
+
|
|
321
|
+
```bash
|
|
322
|
+
$ gtr status
|
|
323
|
+
|
|
324
|
+
π Git Status
|
|
325
|
+
|
|
326
|
+
On branch feat/add-payment-processing
|
|
327
|
+
Changes not staged for commit:
|
|
328
|
+
modified: payment.py
|
|
329
|
+
|
|
330
|
+
ββ π€ AI Suggestion βββββββββββββββββββββββββββ
|
|
331
|
+
β You have unstaged changes in payment.py. β
|
|
332
|
+
β Stage with: gtr add payment.py β
|
|
333
|
+
β Then commit with: gtr commit β
|
|
334
|
+
βββββββββββββββββββββββββββββββββββββββββββββββ
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### AI Branch Name
|
|
338
|
+
|
|
339
|
+
```bash
|
|
340
|
+
$ gtr branch "Fix the memory leak in the payment processor"
|
|
341
|
+
π€ Generating branch name...
|
|
342
|
+
β¨ Generated: fix/memory-leak-payment-processor
|
|
343
|
+
β
π Created and switched to: fix/memory-leak-payment-processor
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
---
|
|
347
|
+
|
|
348
|
+
## πΊοΈ Roadmap
|
|
349
|
+
|
|
350
|
+
### v1.0.0 β
Released
|
|
351
|
+
- AI commit messages
|
|
352
|
+
- AI branch names
|
|
353
|
+
- AI PR descriptions
|
|
354
|
+
- Full git command wrapper
|
|
355
|
+
- Multi-provider AI support (Anthropic, OpenAI, Ollama)
|
|
356
|
+
- Streams workflow
|
|
357
|
+
- Safety guards on destructive commands
|
|
358
|
+
- Setup wizard
|
|
359
|
+
|
|
360
|
+
### v1.1.0 π Coming Soon
|
|
361
|
+
- `gtr chat` β interactive AI chat about your repo (recent commits)
|
|
362
|
+
- `gtr remote` β remote management wrapper
|
|
363
|
+
|
|
364
|
+
### v1.2.0 Premium π
|
|
365
|
+
- `gtr chat` β full repo history, years back
|
|
366
|
+
- Deep commit search by date, author, file
|
|
367
|
+
- Code evolution tracking
|
|
368
|
+
- Team features
|
|
369
|
+
- Freemium model
|
|
370
|
+
|
|
371
|
+
---
|
|
372
|
+
|
|
373
|
+
## π’ About
|
|
374
|
+
|
|
375
|
+
**Gitrama LLC**
|
|
376
|
+
South Carolina Limited Liability Company
|
|
377
|
+
|
|
378
|
+
- π Website: [gitrama.ai](https://gitrama.ai)
|
|
379
|
+
- π§ Contact: contact@gitrama.ai
|
|
380
|
+
- π GitHub: [github.com/ahmaxdev](https://github.com/ahmaxdev)
|
|
381
|
+
|
|
382
|
+
---
|
|
383
|
+
|
|
384
|
+
## βοΈ License
|
|
385
|
+
|
|
386
|
+
Copyright Β© 2026 Gitrama LLC. All Rights Reserved.
|
|
387
|
+
|
|
388
|
+
This software is proprietary and confidential. Unauthorized copying, distribution, or use is strictly prohibited.
|
|
389
|
+
|
|
390
|
+
For licensing inquiries: contact@gitrama.ai
|
|
391
|
+
|
|
392
|
+
---
|
|
393
|
+
|
|
394
|
+
<div align="center">
|
|
395
|
+
|
|
396
|
+
**Built by a developer who was tired of writing commit messages.** πΏ
|
|
397
|
+
|
|
398
|
+
*Stop typing `git`. Start typing `gtr`.*
|
|
399
|
+
|
|
400
|
+
</div>
|