cotop 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.
- cotop-0.1.0/.github/workflows/publish.yml +21 -0
- cotop-0.1.0/.gitignore +5 -0
- cotop-0.1.0/LICENSE +202 -0
- cotop-0.1.0/PKG-INFO +100 -0
- cotop-0.1.0/README.md +76 -0
- cotop-0.1.0/docs/data-sources.md +59 -0
- cotop-0.1.0/docs/images/dashboard.png +0 -0
- cotop-0.1.0/docs/images/stop.png +0 -0
- cotop-0.1.0/pyproject.toml +44 -0
- cotop-0.1.0/scripts/screenshots.py +205 -0
- cotop-0.1.0/src/cotop/__init__.py +0 -0
- cotop-0.1.0/src/cotop/app.py +572 -0
- cotop-0.1.0/src/cotop/colab.py +158 -0
- cotop-0.1.0/src/cotop/model.py +492 -0
- cotop-0.1.0/src/cotop/widgets.py +132 -0
- cotop-0.1.0/tests/__init__.py +0 -0
- cotop-0.1.0/tests/fixtures/resources_g4.txt +2 -0
- cotop-0.1.0/tests/test_app.py +231 -0
- cotop-0.1.0/tests/test_colab.py +13 -0
- cotop-0.1.0/tests/test_model.py +286 -0
- cotop-0.1.0/tests/test_widgets.py +11 -0
- cotop-0.1.0/uv.lock +1412 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Publishes to PyPI when a version tag is pushed, with PyPI trusted publishing:
|
|
2
|
+
# PyPI trusts this workflow's GitHub identity, so no token is stored anywhere.
|
|
3
|
+
name: Publish
|
|
4
|
+
|
|
5
|
+
on:
|
|
6
|
+
push:
|
|
7
|
+
tags: ["v*"]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
pypi:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
permissions:
|
|
13
|
+
id-token: write # the OIDC token PyPI checks
|
|
14
|
+
contents: read
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v4
|
|
17
|
+
- uses: astral-sh/setup-uv@v6
|
|
18
|
+
- name: Tag matches the package version
|
|
19
|
+
run: test "v$(uv version --short)" = "${GITHUB_REF_NAME}"
|
|
20
|
+
- run: uv build
|
|
21
|
+
- run: uv publish
|
cotop-0.1.0/.gitignore
ADDED
cotop-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
cotop-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: cotop
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A top-like terminal dashboard for Google Colab runtimes and compute units
|
|
5
|
+
Project-URL: Homepage, https://github.com/benngarcia/cotop
|
|
6
|
+
Project-URL: Issues, https://github.com/benngarcia/cotop/issues
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Keywords: colab,dashboard,google-colab,gpu,textual,tui
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: Operating System :: MacOS
|
|
15
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: System :: Monitoring
|
|
18
|
+
Requires-Python: >=3.12
|
|
19
|
+
Requires-Dist: google-colab-cli~=0.8.0
|
|
20
|
+
Requires-Dist: packaging
|
|
21
|
+
Requires-Dist: requests
|
|
22
|
+
Requires-Dist: textual>=6
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# cotop
|
|
26
|
+
|
|
27
|
+
`top` for Google Colab: compute units, runtimes and what they cost, live in your terminal.
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
- **Your account:** compute units left, the hourly rate, when you run out, and the rate over the last day.
|
|
32
|
+
- **Runtimes:** every VM on your account, including ones opened in a browser, with a live GPU sparkline, rate, spend, uptime and state. A runtime idle while it bills, out of RAM or disk, or unreachable says so in its row.
|
|
33
|
+
- **The selected runtime:** a braille graph of GPU utilization, read every two seconds, with VRAM, RAM and disk meters, what it has cost and its recent activity. On a runtime without a GPU, the graph shows RAM.
|
|
34
|
+
- **History:** press `h` for past sessions, how long each ran and roughly what it cost.
|
|
35
|
+
- **Actions:** stop a runtime, restart its kernel, or open a shell on it.
|
|
36
|
+
|
|
37
|
+
cotop works on top of the official [Colab CLI](https://pypi.org/project/google-colab-cli/). It uses the CLI's sign-in, session names and history, so runtimes you start with `colab new` show up by name.
|
|
38
|
+
|
|
39
|
+
## Install
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
uv tool install git+https://github.com/benngarcia/cotop
|
|
43
|
+
cotop
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
cotop needs Python 3.12 or later. It is tested on macOS and should work on Linux. If you have not signed in to the Colab CLI yet, cotop runs the same Google sign-in on first launch. On macOS, Keychain may ask once whether cotop's Python can read the Colab CLI's token.
|
|
47
|
+
|
|
48
|
+
## Keys
|
|
49
|
+
|
|
50
|
+
| Key | Action |
|
|
51
|
+
|---|---|
|
|
52
|
+
| `↑` `↓` | Select a runtime |
|
|
53
|
+
| `h` | Past sessions and the hardware your account can use |
|
|
54
|
+
| `r` | Refresh now (cotop also refreshes every 15 seconds) |
|
|
55
|
+
| `s` | Stop the selected runtime |
|
|
56
|
+
| `k` | Restart its kernel |
|
|
57
|
+
| `x` | Open a shell on it with `colab ssh` |
|
|
58
|
+
| `q` | Quit |
|
|
59
|
+
|
|
60
|
+

|
|
61
|
+
|
|
62
|
+
Stop and restart ask first, and Cancel has focus. `colab ssh` looks for `~/.ssh/id_ed25519.pub` or `~/.ssh/id_ecdsa.pub`. For another key, start cotop with `cotop -i ~/.ssh/KEY.pub`. Restart and ssh work only on runtimes started with the Colab CLI. Stop works on any runtime.
|
|
63
|
+
|
|
64
|
+
## Which numbers are estimates
|
|
65
|
+
|
|
66
|
+
Colab reports one hourly rate for the whole account, not one per runtime. cotop shows a per-runtime rate as follows:
|
|
67
|
+
|
|
68
|
+
- With one runtime, the rate is exact.
|
|
69
|
+
- With several runtimes on the same hardware, cotop splits the total evenly.
|
|
70
|
+
- Otherwise cotop uses a rate it learned earlier, when only that hardware was running. These rates are stored in `~/.cache/cotop/rates.json`.
|
|
71
|
+
- With no learned rate, the column shows `?`.
|
|
72
|
+
|
|
73
|
+
Estimates start with `≈`, and upper bounds start with `≤`. Colab boots VMs before it assigns them, so uptime and spend count from the assignment time in the CLI's history. A runtime opened in a browser has no assignment time, so cotop counts from VM boot and shows an upper bound.
|
|
74
|
+
|
|
75
|
+
[docs/data-sources.md](docs/data-sources.md) lists each request cotop makes and what it reads.
|
|
76
|
+
|
|
77
|
+
## Privacy
|
|
78
|
+
|
|
79
|
+
- cotop sends requests only to Google: Colab, and the account endpoint that supplies your email address.
|
|
80
|
+
- It keeps its own files in `~/.cache/cotop`: learned rates, and balance and rate samples.
|
|
81
|
+
- It never shows or stores tokens.
|
|
82
|
+
- From the CLI's history it shows only event types, times and file names. It never shows code, outputs or anything typed at a prompt.
|
|
83
|
+
|
|
84
|
+
## Not affiliated with Google
|
|
85
|
+
|
|
86
|
+
cotop is an independent project. It relies on internal parts of `google-colab-cli` and on Colab endpoints that are not public APIs. Either can change without notice. cotop pins the Colab CLI's minor version for that reason.
|
|
87
|
+
|
|
88
|
+
## Development
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
uv sync
|
|
92
|
+
uv run pytest
|
|
93
|
+
uv run python scripts/screenshots.py OUT_DIR # README screenshots, rendered from made-up data
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
To release, set `version` in `pyproject.toml`, then push a matching tag such as `v0.1.0`. The [publish workflow](.github/workflows/publish.yml) builds the package and uploads it to PyPI with trusted publishing.
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
[Apache 2.0](LICENSE)
|
cotop-0.1.0/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# cotop
|
|
2
|
+
|
|
3
|
+
`top` for Google Colab: compute units, runtimes and what they cost, live in your terminal.
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
- **Your account:** compute units left, the hourly rate, when you run out, and the rate over the last day.
|
|
8
|
+
- **Runtimes:** every VM on your account, including ones opened in a browser, with a live GPU sparkline, rate, spend, uptime and state. A runtime idle while it bills, out of RAM or disk, or unreachable says so in its row.
|
|
9
|
+
- **The selected runtime:** a braille graph of GPU utilization, read every two seconds, with VRAM, RAM and disk meters, what it has cost and its recent activity. On a runtime without a GPU, the graph shows RAM.
|
|
10
|
+
- **History:** press `h` for past sessions, how long each ran and roughly what it cost.
|
|
11
|
+
- **Actions:** stop a runtime, restart its kernel, or open a shell on it.
|
|
12
|
+
|
|
13
|
+
cotop works on top of the official [Colab CLI](https://pypi.org/project/google-colab-cli/). It uses the CLI's sign-in, session names and history, so runtimes you start with `colab new` show up by name.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
uv tool install git+https://github.com/benngarcia/cotop
|
|
19
|
+
cotop
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
cotop needs Python 3.12 or later. It is tested on macOS and should work on Linux. If you have not signed in to the Colab CLI yet, cotop runs the same Google sign-in on first launch. On macOS, Keychain may ask once whether cotop's Python can read the Colab CLI's token.
|
|
23
|
+
|
|
24
|
+
## Keys
|
|
25
|
+
|
|
26
|
+
| Key | Action |
|
|
27
|
+
|---|---|
|
|
28
|
+
| `↑` `↓` | Select a runtime |
|
|
29
|
+
| `h` | Past sessions and the hardware your account can use |
|
|
30
|
+
| `r` | Refresh now (cotop also refreshes every 15 seconds) |
|
|
31
|
+
| `s` | Stop the selected runtime |
|
|
32
|
+
| `k` | Restart its kernel |
|
|
33
|
+
| `x` | Open a shell on it with `colab ssh` |
|
|
34
|
+
| `q` | Quit |
|
|
35
|
+
|
|
36
|
+

|
|
37
|
+
|
|
38
|
+
Stop and restart ask first, and Cancel has focus. `colab ssh` looks for `~/.ssh/id_ed25519.pub` or `~/.ssh/id_ecdsa.pub`. For another key, start cotop with `cotop -i ~/.ssh/KEY.pub`. Restart and ssh work only on runtimes started with the Colab CLI. Stop works on any runtime.
|
|
39
|
+
|
|
40
|
+
## Which numbers are estimates
|
|
41
|
+
|
|
42
|
+
Colab reports one hourly rate for the whole account, not one per runtime. cotop shows a per-runtime rate as follows:
|
|
43
|
+
|
|
44
|
+
- With one runtime, the rate is exact.
|
|
45
|
+
- With several runtimes on the same hardware, cotop splits the total evenly.
|
|
46
|
+
- Otherwise cotop uses a rate it learned earlier, when only that hardware was running. These rates are stored in `~/.cache/cotop/rates.json`.
|
|
47
|
+
- With no learned rate, the column shows `?`.
|
|
48
|
+
|
|
49
|
+
Estimates start with `≈`, and upper bounds start with `≤`. Colab boots VMs before it assigns them, so uptime and spend count from the assignment time in the CLI's history. A runtime opened in a browser has no assignment time, so cotop counts from VM boot and shows an upper bound.
|
|
50
|
+
|
|
51
|
+
[docs/data-sources.md](docs/data-sources.md) lists each request cotop makes and what it reads.
|
|
52
|
+
|
|
53
|
+
## Privacy
|
|
54
|
+
|
|
55
|
+
- cotop sends requests only to Google: Colab, and the account endpoint that supplies your email address.
|
|
56
|
+
- It keeps its own files in `~/.cache/cotop`: learned rates, and balance and rate samples.
|
|
57
|
+
- It never shows or stores tokens.
|
|
58
|
+
- From the CLI's history it shows only event types, times and file names. It never shows code, outputs or anything typed at a prompt.
|
|
59
|
+
|
|
60
|
+
## Not affiliated with Google
|
|
61
|
+
|
|
62
|
+
cotop is an independent project. It relies on internal parts of `google-colab-cli` and on Colab endpoints that are not public APIs. Either can change without notice. cotop pins the Colab CLI's minor version for that reason.
|
|
63
|
+
|
|
64
|
+
## Development
|
|
65
|
+
|
|
66
|
+
```sh
|
|
67
|
+
uv sync
|
|
68
|
+
uv run pytest
|
|
69
|
+
uv run python scripts/screenshots.py OUT_DIR # README screenshots, rendered from made-up data
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
To release, set `version` in `pyproject.toml`, then push a matching tag such as `v0.1.0`. The [publish workflow](.github/workflows/publish.yml) builds the package and uploads it to PyPI with trusted publishing.
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
[Apache 2.0](LICENSE)
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Where cotop's numbers come from
|
|
2
|
+
|
|
3
|
+
cotop polls the account, the runtime list and each runtime's kernels every 15
|
|
4
|
+
seconds, and each runtime's resources every 2 seconds for the graphs. Every
|
|
5
|
+
request is a GET.
|
|
6
|
+
|
|
7
|
+
| Panel | Source | Notes |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| Account email | `openidconnect.googleapis.com/v1/userinfo` | Signed in with the Colab CLI's OAuth token from the OS keyring |
|
|
10
|
+
| Balance, rate, eligible hardware | `colab.research.google.com/tun/m/ccu-info` | The same call as `colab usage`. The CLI drops `eligibleGpus` and `eligibleTpus`; cotop reads the raw body |
|
|
11
|
+
| Runtimes | `/tun/m/assignments` | Every VM the account holds, including ones opened in a browser. These show as *untracked* |
|
|
12
|
+
| Runtime names, running command | `~/.config/colab-cli/sessions.json` | Read under the CLI's file lock and joined on `endpoint`. cotop never prunes or rewrites this file, which `colab sessions` and `colab status` do |
|
|
13
|
+
| Kernel state, idle time, clients | Runtime proxy `/api/kernels`, `/api/status` | Requests carry `?no_track_activity=1` |
|
|
14
|
+
| GPU, VRAM, RAM, disk | Runtime proxy `/api/colab/resources`, every 2 s | The same endpoint the Colab VS Code extension uses. The body has an XSSI prefix. Values change every second; a read takes about 0.4 s. A read that fails or takes over 3 s is a gap in the graph, never a zero |
|
|
15
|
+
| Assignment time, recent events, past sessions | `~/.config/colab-cli/history/*.jsonl` | Only event types, times and file names are shown. Code, outputs and stdin replies are never shown |
|
|
16
|
+
|
|
17
|
+
## Estimates
|
|
18
|
+
|
|
19
|
+
Colab reports only the account's total hourly rate, never a per-runtime rate.
|
|
20
|
+
The `CU/hr` column is therefore:
|
|
21
|
+
|
|
22
|
+
- **exact** when there is one runtime;
|
|
23
|
+
- **≈ split** when every runtime is the same hardware: total ÷ count;
|
|
24
|
+
- **≈ learned** from `~/.cache/cotop/rates.json`, which records each hardware kind's rate
|
|
25
|
+
whenever only that kind is running;
|
|
26
|
+
- **?** otherwise.
|
|
27
|
+
|
|
28
|
+
Colab boots VMs before it assigns them. One G4 runtime booted 21 minutes
|
|
29
|
+
before `colab new` received it. Uptime and spend therefore count from the
|
|
30
|
+
assignment time in the CLI history. For a runtime the CLI did not start,
|
|
31
|
+
the VM's boot time is the only start time available. That figure is an upper
|
|
32
|
+
bound, shown as `≤`.
|
|
33
|
+
|
|
34
|
+
Colab settles the balance in steps a few minutes apart, so a sample taken
|
|
35
|
+
every 15 seconds shows no change for minutes at a time. "Charged last hour" is
|
|
36
|
+
the fall in balance between the first and last settled step in the past hour,
|
|
37
|
+
logged in `~/.cache/cotop/usage.jsonl`. You can compare it with the rate
|
|
38
|
+
Colab reports.
|
|
39
|
+
|
|
40
|
+
## Not verified
|
|
41
|
+
|
|
42
|
+
- Whether reading a runtime's Jupyter API delays Colab's idle shutdown. Requests
|
|
43
|
+
send `no_track_activity=1`, including the reads every 2 seconds. Colab's own
|
|
44
|
+
idle signal is not documented.
|
|
45
|
+
- That billing starts at assignment rather than at VM boot.
|
|
46
|
+
|
|
47
|
+
## Actions
|
|
48
|
+
|
|
49
|
+
| Key | Runs | Notes |
|
|
50
|
+
|---|---|---|
|
|
51
|
+
| `s` | `colab stop -s NAME` | For an untracked runtime, the CLI's `Client.unassign(endpoint)`, because no name exists |
|
|
52
|
+
| `k` | `colab restart-kernel -s NAME` | Only for runtimes the CLI started |
|
|
53
|
+
| `x` | `colab ssh -s NAME [-i KEY]` | The dashboard suspends while the shell runs. A failed connection waits for Enter so its error stays readable |
|
|
54
|
+
|
|
55
|
+
The CLI resolves names, not endpoints. Before a named action, cotop reads
|
|
56
|
+
the assignments and the session file again. It acts only if the name still
|
|
57
|
+
points at the same live VM. A name that was reused since the last poll would
|
|
58
|
+
otherwise point at another VM. `colab ssh` also creates a new runtime for a
|
|
59
|
+
name it does not know.
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "cotop"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "A top-like terminal dashboard for Google Colab runtimes and compute units"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
license = "Apache-2.0"
|
|
7
|
+
license-files = ["LICENSE"]
|
|
8
|
+
requires-python = ">=3.12"
|
|
9
|
+
keywords = ["colab", "google-colab", "tui", "dashboard", "gpu", "textual"]
|
|
10
|
+
classifiers = [
|
|
11
|
+
"Development Status :: 3 - Alpha",
|
|
12
|
+
"Environment :: Console",
|
|
13
|
+
"Intended Audience :: Developers",
|
|
14
|
+
"Intended Audience :: Science/Research",
|
|
15
|
+
"Operating System :: MacOS",
|
|
16
|
+
"Operating System :: POSIX :: Linux",
|
|
17
|
+
"Programming Language :: Python :: 3",
|
|
18
|
+
"Topic :: System :: Monitoring",
|
|
19
|
+
]
|
|
20
|
+
dependencies = [
|
|
21
|
+
# cotop reads the CLI's internals (auth, session file, client), so it pins the minor version.
|
|
22
|
+
"google-colab-cli~=0.8.0",
|
|
23
|
+
"packaging",
|
|
24
|
+
"requests",
|
|
25
|
+
"textual>=6",
|
|
26
|
+
]
|
|
27
|
+
|
|
28
|
+
[project.urls]
|
|
29
|
+
Homepage = "https://github.com/benngarcia/cotop"
|
|
30
|
+
Issues = "https://github.com/benngarcia/cotop/issues"
|
|
31
|
+
|
|
32
|
+
[project.scripts]
|
|
33
|
+
cotop = "cotop.app:main"
|
|
34
|
+
|
|
35
|
+
[dependency-groups]
|
|
36
|
+
dev = ["pytest>=8", "pytest-asyncio>=1"]
|
|
37
|
+
|
|
38
|
+
[build-system]
|
|
39
|
+
requires = ["hatchling"]
|
|
40
|
+
build-backend = "hatchling.build"
|
|
41
|
+
|
|
42
|
+
[tool.pytest.ini_options]
|
|
43
|
+
asyncio_mode = "auto"
|
|
44
|
+
asyncio_default_fixture_loop_scope = "function"
|