ccburn 0.1.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.
ccburn-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 JuanjoFuchs
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.
ccburn-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,197 @@
1
+ Metadata-Version: 2.4
2
+ Name: ccburn
3
+ Version: 0.1.0
4
+ Summary: Terminal-based Claude Code usage limit visualizer with real-time burn-up charts
5
+ Author: JuanjoFuchs
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/JuanjoFuchs/ccburn
8
+ Project-URL: Repository, https://github.com/JuanjoFuchs/ccburn.git
9
+ Project-URL: Issues, https://github.com/JuanjoFuchs/ccburn/issues
10
+ Project-URL: Documentation, https://github.com/JuanjoFuchs/ccburn#readme
11
+ Keywords: claude,anthropic,usage,monitoring,tui,visualization,cli
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Utilities
22
+ Classifier: Topic :: System :: Monitoring
23
+ Requires-Python: >=3.10
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: typer[all]>=0.9.0
27
+ Requires-Dist: rich>=13.0.0
28
+ Requires-Dist: plotext>=5.2.0
29
+ Requires-Dist: httpx>=0.25.0
30
+ Provides-Extra: dev
31
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
32
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
33
+ Requires-Dist: ruff>=0.1.0; extra == "dev"
34
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
35
+ Requires-Dist: build>=1.0.0; extra == "dev"
36
+ Requires-Dist: twine>=4.0.0; extra == "dev"
37
+ Requires-Dist: pyinstaller>=6.0.0; extra == "dev"
38
+ Dynamic: license-file
39
+
40
+ # ccburn
41
+
42
+ [![CI](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/ccburn/ci.yml?branch=main&label=CI)](https://github.com/JuanjoFuchs/ccburn/actions/workflows/ci.yml)
43
+ [![Release](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/ccburn/release.yml?label=Release)](https://github.com/JuanjoFuchs/ccburn/actions/workflows/release.yml)
44
+ [![PyPI](https://img.shields.io/pypi/v/ccburn)](https://pypi.org/project/ccburn/)
45
+ [![Python](https://img.shields.io/pypi/pyversions/ccburn)](https://pypi.org/project/ccburn/)
46
+ [![GitHub Release](https://img.shields.io/github/v/release/JuanjoFuchs/ccburn)](https://github.com/JuanjoFuchs/ccburn/releases)
47
+ [![WinGet](https://img.shields.io/badge/WinGet-JuanjoFuchs.ccburn-blue)](https://winstall.app/apps/JuanjoFuchs.ccburn)
48
+ [![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
49
+
50
+ TUI and CLI for Claude Code usage limits — burn-up charts, compact mode for status bars, JSON for automation.
51
+
52
+ ![ccburn screenshot](docs/ccburn.png)
53
+
54
+ ## Features
55
+
56
+ - **Real-time burn-up charts** — Visualize session and weekly usage with live-updating terminal graphics
57
+ - **Pace indicators** — See if you're ahead, on pace, or behind your usage budget (🧊/🔥/🚨)
58
+ - **Multiple output modes** — Full TUI, compact single-line for status bars, or JSON for scripting
59
+ - **Automatic data persistence** — SQLite-backed history for trend analysis
60
+ - **Dynamic window title** — Terminal tab shows current usage at a glance
61
+ - **Zoom views** — Focus on recent activity with `--since`
62
+
63
+ ## Installation
64
+
65
+ ### Windows (WinGet)
66
+
67
+ ```powershell
68
+ winget install JuanjoFuchs.ccburn
69
+ ```
70
+
71
+ ### Cross-Platform (pip)
72
+
73
+ ```bash
74
+ pip install ccburn
75
+ ```
76
+
77
+ ### From Source
78
+
79
+ ```bash
80
+ git clone https://github.com/JuanjoFuchs/ccburn.git
81
+ cd ccburn
82
+ pip install -e ".[dev]"
83
+ ```
84
+
85
+ ## Quick Start
86
+
87
+ 1. **Ensure Claude Code is installed** — ccburn reads credentials from Claude Code's config
88
+ 2. **Run ccburn:**
89
+ ```bash
90
+ ccburn # Session limit (default)
91
+ ccburn weekly # Weekly limit
92
+ ccburn weekly-sonnet # Weekly Sonnet limit
93
+ ```
94
+
95
+ ## Usage Examples
96
+
97
+ ```bash
98
+ # Full TUI with burn-up chart (default)
99
+ ccburn
100
+
101
+ # Weekly usage view
102
+ ccburn weekly
103
+
104
+ # Compact output for tmux/status bars
105
+ ccburn --compact
106
+ # Output: Session: 🔥 45% (2h14m) | Weekly: 🧊 12% | Sonnet: 🧊 3%
107
+
108
+ # JSON output for scripting/automation
109
+ ccburn --json
110
+
111
+ # Zoom to last 30 minutes
112
+ ccburn --since 30m
113
+
114
+ # Single snapshot (no live updates)
115
+ ccburn --once
116
+
117
+ # Custom refresh interval (seconds)
118
+ ccburn --interval 10
119
+ ```
120
+
121
+ ## Command Line Reference
122
+
123
+ ```
124
+ Usage: ccburn [OPTIONS] [LIMIT]
125
+
126
+ Arguments:
127
+ [LIMIT] Which limit to display [default: session]
128
+ Options: session, weekly, weekly-sonnet
129
+
130
+ Options:
131
+ -i, --interval INTEGER Refresh interval in seconds [default: 5/30]
132
+ -s, --since TEXT Only show data since (e.g., 30m, 2h, 1d)
133
+ -j, --json Output JSON and exit
134
+ -o, --once Print once and exit (no live updates)
135
+ -c, --compact Single-line output for status bars
136
+ --debug Show debug information
137
+ --version Show version and exit
138
+ --help Show this message and exit
139
+ ```
140
+
141
+ ## Pace Indicators
142
+
143
+ | Emoji | Status | Meaning |
144
+ |-------|--------|---------|
145
+ | 🧊 | Behind pace | Usage below expected budget — you have headroom |
146
+ | 🔥 | On pace | Usage tracking with expected budget |
147
+ | 🚨 | Ahead of pace | Usage above expected budget — slow down! |
148
+
149
+ ## Requirements
150
+
151
+ - **Python 3.10+**
152
+ - **Claude Code** installed with valid credentials
153
+ - Terminal with Unicode support (for charts and emojis)
154
+
155
+ ## How It Works
156
+
157
+ ccburn reads your Claude Code credentials and fetches usage data from the Anthropic API. It calculates:
158
+
159
+ - **Budget pace** — Where you "should" be based on time elapsed in the window
160
+ - **Burn rate** — How fast you're consuming your limit
161
+ - **Time to limit** — Estimated time until you hit 100% (if current rate continues)
162
+
163
+ Data is stored locally in SQLite for historical analysis and to minimize API calls when running multiple instances.
164
+
165
+ ## Troubleshooting
166
+
167
+ ### "Credentials not found"
168
+
169
+ Ensure Claude Code is installed and you've logged in at least once:
170
+ ```bash
171
+ claude # This will prompt for login if needed
172
+ ```
173
+
174
+ ### Chart not displaying correctly
175
+
176
+ Ensure your terminal supports Unicode and has a monospace font with emoji support. Recommended terminals:
177
+ - **Windows**: Windows Terminal
178
+ - **macOS**: iTerm2, Terminal.app
179
+ - **Linux**: Kitty, Alacritty, GNOME Terminal
180
+
181
+ ### Stale data indicator
182
+
183
+ If you see "(stale)" in the header, ccburn couldn't reach the API. It will continue showing cached data and retry automatically.
184
+
185
+ ## Contributing
186
+
187
+ Contributions are welcome! Please feel free to submit a Pull Request.
188
+
189
+ ## License
190
+
191
+ [MIT](LICENSE)
192
+
193
+ ## Acknowledgments
194
+
195
+ - [Rich](https://github.com/Textualize/rich) — Beautiful terminal formatting
196
+ - [Plotext](https://github.com/piccolomo/plotext) — Terminal plotting
197
+ - [Typer](https://github.com/tiangolo/typer) — CLI framework
ccburn-0.1.0/README.md ADDED
@@ -0,0 +1,158 @@
1
+ # ccburn
2
+
3
+ [![CI](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/ccburn/ci.yml?branch=main&label=CI)](https://github.com/JuanjoFuchs/ccburn/actions/workflows/ci.yml)
4
+ [![Release](https://img.shields.io/github/actions/workflow/status/JuanjoFuchs/ccburn/release.yml?label=Release)](https://github.com/JuanjoFuchs/ccburn/actions/workflows/release.yml)
5
+ [![PyPI](https://img.shields.io/pypi/v/ccburn)](https://pypi.org/project/ccburn/)
6
+ [![Python](https://img.shields.io/pypi/pyversions/ccburn)](https://pypi.org/project/ccburn/)
7
+ [![GitHub Release](https://img.shields.io/github/v/release/JuanjoFuchs/ccburn)](https://github.com/JuanjoFuchs/ccburn/releases)
8
+ [![WinGet](https://img.shields.io/badge/WinGet-JuanjoFuchs.ccburn-blue)](https://winstall.app/apps/JuanjoFuchs.ccburn)
9
+ [![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
10
+
11
+ TUI and CLI for Claude Code usage limits — burn-up charts, compact mode for status bars, JSON for automation.
12
+
13
+ ![ccburn screenshot](docs/ccburn.png)
14
+
15
+ ## Features
16
+
17
+ - **Real-time burn-up charts** — Visualize session and weekly usage with live-updating terminal graphics
18
+ - **Pace indicators** — See if you're ahead, on pace, or behind your usage budget (🧊/🔥/🚨)
19
+ - **Multiple output modes** — Full TUI, compact single-line for status bars, or JSON for scripting
20
+ - **Automatic data persistence** — SQLite-backed history for trend analysis
21
+ - **Dynamic window title** — Terminal tab shows current usage at a glance
22
+ - **Zoom views** — Focus on recent activity with `--since`
23
+
24
+ ## Installation
25
+
26
+ ### Windows (WinGet)
27
+
28
+ ```powershell
29
+ winget install JuanjoFuchs.ccburn
30
+ ```
31
+
32
+ ### Cross-Platform (pip)
33
+
34
+ ```bash
35
+ pip install ccburn
36
+ ```
37
+
38
+ ### From Source
39
+
40
+ ```bash
41
+ git clone https://github.com/JuanjoFuchs/ccburn.git
42
+ cd ccburn
43
+ pip install -e ".[dev]"
44
+ ```
45
+
46
+ ## Quick Start
47
+
48
+ 1. **Ensure Claude Code is installed** — ccburn reads credentials from Claude Code's config
49
+ 2. **Run ccburn:**
50
+ ```bash
51
+ ccburn # Session limit (default)
52
+ ccburn weekly # Weekly limit
53
+ ccburn weekly-sonnet # Weekly Sonnet limit
54
+ ```
55
+
56
+ ## Usage Examples
57
+
58
+ ```bash
59
+ # Full TUI with burn-up chart (default)
60
+ ccburn
61
+
62
+ # Weekly usage view
63
+ ccburn weekly
64
+
65
+ # Compact output for tmux/status bars
66
+ ccburn --compact
67
+ # Output: Session: 🔥 45% (2h14m) | Weekly: 🧊 12% | Sonnet: 🧊 3%
68
+
69
+ # JSON output for scripting/automation
70
+ ccburn --json
71
+
72
+ # Zoom to last 30 minutes
73
+ ccburn --since 30m
74
+
75
+ # Single snapshot (no live updates)
76
+ ccburn --once
77
+
78
+ # Custom refresh interval (seconds)
79
+ ccburn --interval 10
80
+ ```
81
+
82
+ ## Command Line Reference
83
+
84
+ ```
85
+ Usage: ccburn [OPTIONS] [LIMIT]
86
+
87
+ Arguments:
88
+ [LIMIT] Which limit to display [default: session]
89
+ Options: session, weekly, weekly-sonnet
90
+
91
+ Options:
92
+ -i, --interval INTEGER Refresh interval in seconds [default: 5/30]
93
+ -s, --since TEXT Only show data since (e.g., 30m, 2h, 1d)
94
+ -j, --json Output JSON and exit
95
+ -o, --once Print once and exit (no live updates)
96
+ -c, --compact Single-line output for status bars
97
+ --debug Show debug information
98
+ --version Show version and exit
99
+ --help Show this message and exit
100
+ ```
101
+
102
+ ## Pace Indicators
103
+
104
+ | Emoji | Status | Meaning |
105
+ |-------|--------|---------|
106
+ | 🧊 | Behind pace | Usage below expected budget — you have headroom |
107
+ | 🔥 | On pace | Usage tracking with expected budget |
108
+ | 🚨 | Ahead of pace | Usage above expected budget — slow down! |
109
+
110
+ ## Requirements
111
+
112
+ - **Python 3.10+**
113
+ - **Claude Code** installed with valid credentials
114
+ - Terminal with Unicode support (for charts and emojis)
115
+
116
+ ## How It Works
117
+
118
+ ccburn reads your Claude Code credentials and fetches usage data from the Anthropic API. It calculates:
119
+
120
+ - **Budget pace** — Where you "should" be based on time elapsed in the window
121
+ - **Burn rate** — How fast you're consuming your limit
122
+ - **Time to limit** — Estimated time until you hit 100% (if current rate continues)
123
+
124
+ Data is stored locally in SQLite for historical analysis and to minimize API calls when running multiple instances.
125
+
126
+ ## Troubleshooting
127
+
128
+ ### "Credentials not found"
129
+
130
+ Ensure Claude Code is installed and you've logged in at least once:
131
+ ```bash
132
+ claude # This will prompt for login if needed
133
+ ```
134
+
135
+ ### Chart not displaying correctly
136
+
137
+ Ensure your terminal supports Unicode and has a monospace font with emoji support. Recommended terminals:
138
+ - **Windows**: Windows Terminal
139
+ - **macOS**: iTerm2, Terminal.app
140
+ - **Linux**: Kitty, Alacritty, GNOME Terminal
141
+
142
+ ### Stale data indicator
143
+
144
+ If you see "(stale)" in the header, ccburn couldn't reach the API. It will continue showing cached data and retry automatically.
145
+
146
+ ## Contributing
147
+
148
+ Contributions are welcome! Please feel free to submit a Pull Request.
149
+
150
+ ## License
151
+
152
+ [MIT](LICENSE)
153
+
154
+ ## Acknowledgments
155
+
156
+ - [Rich](https://github.com/Textualize/rich) — Beautiful terminal formatting
157
+ - [Plotext](https://github.com/piccolomo/plotext) — Terminal plotting
158
+ - [Typer](https://github.com/tiangolo/typer) — CLI framework
@@ -0,0 +1,97 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "ccburn"
7
+ version = "0.1.0"
8
+ description = "Terminal-based Claude Code usage limit visualizer with real-time burn-up charts"
9
+ authors = [{name = "JuanjoFuchs"}]
10
+ readme = "README.md"
11
+ license = "MIT"
12
+ requires-python = ">=3.10"
13
+ keywords = ["claude", "anthropic", "usage", "monitoring", "tui", "visualization", "cli"]
14
+ classifiers = [
15
+ "Development Status :: 4 - Beta",
16
+ "Environment :: Console",
17
+ "Intended Audience :: Developers",
18
+ "Operating System :: OS Independent",
19
+ "Programming Language :: Python :: 3",
20
+ "Programming Language :: Python :: 3.10",
21
+ "Programming Language :: Python :: 3.11",
22
+ "Programming Language :: Python :: 3.12",
23
+ "Programming Language :: Python :: 3.13",
24
+ "Topic :: Utilities",
25
+ "Topic :: System :: Monitoring",
26
+ ]
27
+ dependencies = [
28
+ "typer[all]>=0.9.0",
29
+ "rich>=13.0.0",
30
+ "plotext>=5.2.0",
31
+ "httpx>=0.25.0",
32
+ ]
33
+
34
+ [project.optional-dependencies]
35
+ dev = [
36
+ "pytest>=7.0.0",
37
+ "pytest-cov>=4.0.0",
38
+ "ruff>=0.1.0",
39
+ "mypy>=1.0.0",
40
+ "build>=1.0.0",
41
+ "twine>=4.0.0",
42
+ "pyinstaller>=6.0.0",
43
+ ]
44
+
45
+ [project.scripts]
46
+ ccburn = "ccburn.main:app"
47
+
48
+ [project.urls]
49
+ Homepage = "https://github.com/JuanjoFuchs/ccburn"
50
+ Repository = "https://github.com/JuanjoFuchs/ccburn.git"
51
+ Issues = "https://github.com/JuanjoFuchs/ccburn/issues"
52
+ Documentation = "https://github.com/JuanjoFuchs/ccburn#readme"
53
+
54
+ [tool.setuptools.packages.find]
55
+ where = ["src"]
56
+
57
+ [tool.setuptools.package-dir]
58
+ "" = "src"
59
+
60
+ [tool.ruff]
61
+ line-length = 100
62
+ target-version = "py310"
63
+
64
+ [tool.ruff.lint]
65
+ select = [
66
+ "E", # pycodestyle errors
67
+ "W", # pycodestyle warnings
68
+ "F", # pyflakes
69
+ "I", # isort
70
+ "B", # flake8-bugbear
71
+ "C4", # flake8-comprehensions
72
+ "UP", # pyupgrade
73
+ ]
74
+ ignore = [
75
+ "E501", # line too long, handled by formatter
76
+ "B008", # do not perform function calls in argument defaults (typer uses this)
77
+ ]
78
+
79
+ [tool.mypy]
80
+ python_version = "3.10"
81
+ warn_return_any = true
82
+ warn_unused_configs = true
83
+ disallow_untyped_defs = true
84
+ check_untyped_defs = true
85
+ no_implicit_optional = true
86
+ warn_redundant_casts = true
87
+ warn_unused_ignores = true
88
+ strict_equality = true
89
+
90
+ [[tool.mypy.overrides]]
91
+ module = ["plotext", "httpx"]
92
+ ignore_missing_imports = true
93
+
94
+ [tool.pytest.ini_options]
95
+ minversion = "7.0"
96
+ addopts = "-ra -q --strict-markers"
97
+ testpaths = ["tests"]
ccburn-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,8 @@
1
+ # ccburn - Terminal-based Claude Code usage limit visualizer
2
+
3
+ try:
4
+ from importlib.metadata import version
5
+
6
+ __version__ = version("ccburn")
7
+ except Exception:
8
+ __version__ = "0.0.0"