git-ember 1.4.0__tar.gz → 1.4.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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-ember
3
- Version: 1.4.0
3
+ Version: 1.4.2
4
4
  Summary: A GitHub-style heatmap of commits and local repo statistics for your terminal
5
5
  Author-email: Luka van Rooyen <lukavrooyen@proton.me>
6
6
  License-Expression: MIT
@@ -22,6 +22,9 @@ Dynamic: license-file
22
22
 
23
23
  # git-ember
24
24
 
25
+ [![PyPI](https://img.shields.io/pypi/v/git-ember)](https://pypi.org/project/git-ember/)
26
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
27
+
25
28
  A GitHub-style heatmap of commit activity for your terminal.
26
29
 
27
30
  ## Overview
@@ -35,6 +38,14 @@ git-ember reads directly from your local Git repository history—no external AP
35
38
 
36
39
  ## Installation
37
40
 
41
+ ### From PyPI (recommended)
42
+
43
+ ```bash
44
+ pip install git-ember
45
+ ```
46
+
47
+ ### From source
48
+
38
49
  1. Clone the repository:
39
50
 
40
51
  ```bash
@@ -54,6 +65,14 @@ git-ember reads directly from your local Git repository history—no external AP
54
65
  git-ember --version
55
66
  ```
56
67
 
68
+ ### Using uv
69
+
70
+ If you use [uv](https://github.com/astral-sh/uv) as your package manager:
71
+
72
+ ```bash
73
+ uv pip install git-ember
74
+ ```
75
+
57
76
  ### Running without installation
58
77
 
59
78
  If you prefer not to install the package, run directly:
@@ -72,13 +91,18 @@ pip uninstall git-ember
72
91
 
73
92
  git-ember reads configuration from `~/.config/git-ember/config.toml` (or the platform-specific config directory). CLI arguments take precedence over config values.
74
93
 
75
- | Variable | Required | Default | Description |
76
- |------------|----------|-----------|-------------------------------------|
77
- | `color` | No | `green` | Color scheme name |
78
- | `border` | No | `=` | Border character |
79
- | `week_start`| No | `sunday` | Week start day (sunday/monday) |
80
- | `ascii` | No | `false` | Use ASCII characters |
81
- | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
94
+ | Variable | Required | Default | Description |
95
+ |----------------|----------|-----------|--------------------------------------------------|
96
+ | `color` | No | `green` | Color scheme name |
97
+ | `border` | No | `=` | Border character |
98
+ | `week_start` | No | `sunday` | Week start day (sunday/monday) |
99
+ | `ascii` | No | `false` | Use ASCII characters |
100
+ | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
101
+ | `extended` | No | `false` | Show extended report by default |
102
+ | `compact` | No | `false` | Show last 4 months only |
103
+ | `tree` | No | `false` | Show branch tree by default |
104
+ | `years` | No | `1` | Number of years to show |
105
+ | `recent_count` | No | `5` | Number of recent commits to display |
82
106
 
83
107
  ### Example config file
84
108
 
@@ -88,6 +112,11 @@ border = "-"
88
112
  week_start = "monday"
89
113
  ascii = "true"
90
114
  scale = "adaptive"
115
+ extended = "true"
116
+ compact = "true"
117
+ tree = "true"
118
+ years = 2
119
+ recent_count = 10
91
120
  ```
92
121
 
93
122
  ## Usage
@@ -182,6 +211,18 @@ git-ember --plain
182
211
  git-ember --plain > heatmap.txt
183
212
  ```
184
213
 
214
+ Reset configuration to defaults:
215
+
216
+ ```bash
217
+ git-ember --reset-default
218
+ ```
219
+
220
+ Show debug information:
221
+
222
+ ```bash
223
+ git-ember --verbose
224
+ ```
225
+
185
226
  ### Command-line options
186
227
 
187
228
  | Flag | Alias | Description | Default |
@@ -204,7 +245,9 @@ git-ember --plain > heatmap.txt
204
245
  | `--merges-only` | - | Show only merge commits | `false` |
205
246
  | `--grep` | - | Filter commits by message content | - |
206
247
  | `--hourly` | - | Show hour-of-day x day-of-week heatmap | `false` |
248
+ | `--reset-default` | - | Reset config to defaults | - |
207
249
  | `--version` | `-V` | Show version | - |
250
+ | `--verbose` | `-v` | Show debug information | - |
208
251
  | `--help` | `-h` | Show help | - |
209
252
 
210
253
  ## Project Structure
@@ -248,6 +291,12 @@ Run tests:
248
291
  pytest
249
292
  ```
250
293
 
294
+ Run tests with coverage:
295
+
296
+ ```bash
297
+ pytest --cov=gitember --cov-report=term-missing
298
+ ```
299
+
251
300
  ## License
252
301
 
253
302
  MIT License — see [LICENSE](LICENSE) file.
@@ -1,5 +1,8 @@
1
1
  # git-ember
2
2
 
3
+ [![PyPI](https://img.shields.io/pypi/v/git-ember)](https://pypi.org/project/git-ember/)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
3
6
  A GitHub-style heatmap of commit activity for your terminal.
4
7
 
5
8
  ## Overview
@@ -13,6 +16,14 @@ git-ember reads directly from your local Git repository history—no external AP
13
16
 
14
17
  ## Installation
15
18
 
19
+ ### From PyPI (recommended)
20
+
21
+ ```bash
22
+ pip install git-ember
23
+ ```
24
+
25
+ ### From source
26
+
16
27
  1. Clone the repository:
17
28
 
18
29
  ```bash
@@ -32,6 +43,14 @@ git-ember reads directly from your local Git repository history—no external AP
32
43
  git-ember --version
33
44
  ```
34
45
 
46
+ ### Using uv
47
+
48
+ If you use [uv](https://github.com/astral-sh/uv) as your package manager:
49
+
50
+ ```bash
51
+ uv pip install git-ember
52
+ ```
53
+
35
54
  ### Running without installation
36
55
 
37
56
  If you prefer not to install the package, run directly:
@@ -50,13 +69,18 @@ pip uninstall git-ember
50
69
 
51
70
  git-ember reads configuration from `~/.config/git-ember/config.toml` (or the platform-specific config directory). CLI arguments take precedence over config values.
52
71
 
53
- | Variable | Required | Default | Description |
54
- |------------|----------|-----------|-------------------------------------|
55
- | `color` | No | `green` | Color scheme name |
56
- | `border` | No | `=` | Border character |
57
- | `week_start`| No | `sunday` | Week start day (sunday/monday) |
58
- | `ascii` | No | `false` | Use ASCII characters |
59
- | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
72
+ | Variable | Required | Default | Description |
73
+ |----------------|----------|-----------|--------------------------------------------------|
74
+ | `color` | No | `green` | Color scheme name |
75
+ | `border` | No | `=` | Border character |
76
+ | `week_start` | No | `sunday` | Week start day (sunday/monday) |
77
+ | `ascii` | No | `false` | Use ASCII characters |
78
+ | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
79
+ | `extended` | No | `false` | Show extended report by default |
80
+ | `compact` | No | `false` | Show last 4 months only |
81
+ | `tree` | No | `false` | Show branch tree by default |
82
+ | `years` | No | `1` | Number of years to show |
83
+ | `recent_count` | No | `5` | Number of recent commits to display |
60
84
 
61
85
  ### Example config file
62
86
 
@@ -66,6 +90,11 @@ border = "-"
66
90
  week_start = "monday"
67
91
  ascii = "true"
68
92
  scale = "adaptive"
93
+ extended = "true"
94
+ compact = "true"
95
+ tree = "true"
96
+ years = 2
97
+ recent_count = 10
69
98
  ```
70
99
 
71
100
  ## Usage
@@ -160,6 +189,18 @@ git-ember --plain
160
189
  git-ember --plain > heatmap.txt
161
190
  ```
162
191
 
192
+ Reset configuration to defaults:
193
+
194
+ ```bash
195
+ git-ember --reset-default
196
+ ```
197
+
198
+ Show debug information:
199
+
200
+ ```bash
201
+ git-ember --verbose
202
+ ```
203
+
163
204
  ### Command-line options
164
205
 
165
206
  | Flag | Alias | Description | Default |
@@ -182,7 +223,9 @@ git-ember --plain > heatmap.txt
182
223
  | `--merges-only` | - | Show only merge commits | `false` |
183
224
  | `--grep` | - | Filter commits by message content | - |
184
225
  | `--hourly` | - | Show hour-of-day x day-of-week heatmap | `false` |
226
+ | `--reset-default` | - | Reset config to defaults | - |
185
227
  | `--version` | `-V` | Show version | - |
228
+ | `--verbose` | `-v` | Show debug information | - |
186
229
  | `--help` | `-h` | Show help | - |
187
230
 
188
231
  ## Project Structure
@@ -226,6 +269,12 @@ Run tests:
226
269
  pytest
227
270
  ```
228
271
 
272
+ Run tests with coverage:
273
+
274
+ ```bash
275
+ pytest --cov=gitember --cov-report=term-missing
276
+ ```
277
+
229
278
  ## License
230
279
 
231
280
  MIT License — see [LICENSE](LICENSE) file.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "git-ember"
3
- version = "1.4.0"
3
+ version = "1.4.2"
4
4
  description = "A GitHub-style heatmap of commits and local repo statistics for your terminal"
5
5
  readme = "README.md"
6
6
  authors = [{name = "Luka van Rooyen", email = "lukavrooyen@proton.me"}]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-ember
3
- Version: 1.4.0
3
+ Version: 1.4.2
4
4
  Summary: A GitHub-style heatmap of commits and local repo statistics for your terminal
5
5
  Author-email: Luka van Rooyen <lukavrooyen@proton.me>
6
6
  License-Expression: MIT
@@ -22,6 +22,9 @@ Dynamic: license-file
22
22
 
23
23
  # git-ember
24
24
 
25
+ [![PyPI](https://img.shields.io/pypi/v/git-ember)](https://pypi.org/project/git-ember/)
26
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
27
+
25
28
  A GitHub-style heatmap of commit activity for your terminal.
26
29
 
27
30
  ## Overview
@@ -35,6 +38,14 @@ git-ember reads directly from your local Git repository history—no external AP
35
38
 
36
39
  ## Installation
37
40
 
41
+ ### From PyPI (recommended)
42
+
43
+ ```bash
44
+ pip install git-ember
45
+ ```
46
+
47
+ ### From source
48
+
38
49
  1. Clone the repository:
39
50
 
40
51
  ```bash
@@ -54,6 +65,14 @@ git-ember reads directly from your local Git repository history—no external AP
54
65
  git-ember --version
55
66
  ```
56
67
 
68
+ ### Using uv
69
+
70
+ If you use [uv](https://github.com/astral-sh/uv) as your package manager:
71
+
72
+ ```bash
73
+ uv pip install git-ember
74
+ ```
75
+
57
76
  ### Running without installation
58
77
 
59
78
  If you prefer not to install the package, run directly:
@@ -72,13 +91,18 @@ pip uninstall git-ember
72
91
 
73
92
  git-ember reads configuration from `~/.config/git-ember/config.toml` (or the platform-specific config directory). CLI arguments take precedence over config values.
74
93
 
75
- | Variable | Required | Default | Description |
76
- |------------|----------|-----------|-------------------------------------|
77
- | `color` | No | `green` | Color scheme name |
78
- | `border` | No | `=` | Border character |
79
- | `week_start`| No | `sunday` | Week start day (sunday/monday) |
80
- | `ascii` | No | `false` | Use ASCII characters |
81
- | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
94
+ | Variable | Required | Default | Description |
95
+ |----------------|----------|-----------|--------------------------------------------------|
96
+ | `color` | No | `green` | Color scheme name |
97
+ | `border` | No | `=` | Border character |
98
+ | `week_start` | No | `sunday` | Week start day (sunday/monday) |
99
+ | `ascii` | No | `false` | Use ASCII characters |
100
+ | `scale` | No | `auto` | Intensity scaling (auto/adaptive) |
101
+ | `extended` | No | `false` | Show extended report by default |
102
+ | `compact` | No | `false` | Show last 4 months only |
103
+ | `tree` | No | `false` | Show branch tree by default |
104
+ | `years` | No | `1` | Number of years to show |
105
+ | `recent_count` | No | `5` | Number of recent commits to display |
82
106
 
83
107
  ### Example config file
84
108
 
@@ -88,6 +112,11 @@ border = "-"
88
112
  week_start = "monday"
89
113
  ascii = "true"
90
114
  scale = "adaptive"
115
+ extended = "true"
116
+ compact = "true"
117
+ tree = "true"
118
+ years = 2
119
+ recent_count = 10
91
120
  ```
92
121
 
93
122
  ## Usage
@@ -182,6 +211,18 @@ git-ember --plain
182
211
  git-ember --plain > heatmap.txt
183
212
  ```
184
213
 
214
+ Reset configuration to defaults:
215
+
216
+ ```bash
217
+ git-ember --reset-default
218
+ ```
219
+
220
+ Show debug information:
221
+
222
+ ```bash
223
+ git-ember --verbose
224
+ ```
225
+
185
226
  ### Command-line options
186
227
 
187
228
  | Flag | Alias | Description | Default |
@@ -204,7 +245,9 @@ git-ember --plain > heatmap.txt
204
245
  | `--merges-only` | - | Show only merge commits | `false` |
205
246
  | `--grep` | - | Filter commits by message content | - |
206
247
  | `--hourly` | - | Show hour-of-day x day-of-week heatmap | `false` |
248
+ | `--reset-default` | - | Reset config to defaults | - |
207
249
  | `--version` | `-V` | Show version | - |
250
+ | `--verbose` | `-v` | Show debug information | - |
208
251
  | `--help` | `-h` | Show help | - |
209
252
 
210
253
  ## Project Structure
@@ -248,6 +291,12 @@ Run tests:
248
291
  pytest
249
292
  ```
250
293
 
294
+ Run tests with coverage:
295
+
296
+ ```bash
297
+ pytest --cov=gitember --cov-report=term-missing
298
+ ```
299
+
251
300
  ## License
252
301
 
253
302
  MIT License — see [LICENSE](LICENSE) file.
@@ -12,6 +12,7 @@ src/gitember/colors.py
12
12
  src/gitember/config.py
13
13
  src/gitember/git.py
14
14
  src/gitember/render.py
15
+ tests/test_cli.py
15
16
  tests/test_config.py
16
17
  tests/test_git.py
17
18
  tests/test_render.py
@@ -1,4 +1,3 @@
1
- # in __init__.py
2
1
  from importlib.metadata import PackageNotFoundError, version
3
2
 
4
3
  try: