colabcola 0.1.0__tar.gz

colabcola-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

colabcola-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include pyproject.toml MANIFEST.in
+recursive-include src/colabcola *.py *.json
+recursive-include src/colabcola/_vendor LICENSE
+include tools/build_development.py tools/vendor_provider.py
+prune tests
+prune examples
+prune jobs
+prune dist
+prune build
+global-exclude __pycache__ *.py[cod]
+
+recursive-include docs *.md *.svg *.png

colabcola-0.1.0/NOTICE

@@ -0,0 +1,24 @@
+Colab Cola
+Copyright 2026 Colab Cola contributors
+
+Except where otherwise indicated, Colab Cola's original source code is
+licensed under the Apache License, Version 2.0. See the root LICENSE file.
+
+This distribution incorporates separately licensed third-party source:
+
+Google Colab CLI
+  Upstream: https://github.com/googlecolab/google-colab-cli
+  Vendored path: src/colabcola/_vendor/colab_cli/
+  License: Apache License, Version 2.0 (Apache-2.0)
+  License text: src/colabcola/_vendor/colab_cli/LICENSE
+
+Datalayer Jupyter Kernel Client
+  Copyright (c) 2025, Datalayer
+  Vendored path: src/colabcola/_vendor/jupyter_kernel_client/
+  License: BSD 3-Clause License (BSD-3-Clause)
+  License text: src/colabcola/_vendor/jupyter_kernel_client/LICENSE
+
+The separate copyright notices, conditions, and disclaimers of these
+third-party components remain applicable. Nothing in this NOTICE changes
+the licensing of those components or suggests their authors endorse
+Colab Cola.

colabcola-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: colabcola
+Version: 0.1.0
+Summary: Package, run, and recover Python workloads on Google Colab from the command line.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/dependanz/colabcola
+Project-URL: Repository, https://github.com/dependanz/colabcola
+Project-URL: Issues, https://github.com/dependanz/colabcola/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: src/colabcola/_vendor/colab_cli/LICENSE
+License-File: src/colabcola/_vendor/jupyter_kernel_client/LICENSE
+Requires-Dist: packaging<27,>=24
+Requires-Dist: requests<3,>=2.32.5
+Requires-Dist: google-api-python-client<3,>=2.100
+Requires-Dist: google-auth-oauthlib<2,>=1.2
+Requires-Dist: keyring<27,>=25
+Requires-Dist: filelock<4,>=3.29.2
+Requires-Dist: google-auth<3,>=2.49.1
+Requires-Dist: html2text>=2024.2.26
+Requires-Dist: pydantic<3,>=2.12.5
+Requires-Dist: rich<15,>=14.3.3
+Requires-Dist: jupyter-core<6,>=5
+Requires-Dist: jupyter-client<9,>=8.6.3
+Requires-Dist: jupyter-mimetypes<1,>=0.2
+Requires-Dist: traitlets<6,>=5.3
+Requires-Dist: typing-extensions>=4
+Requires-Dist: websocket-client<2,>=1.6
+Provides-Extra: colab
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dependanz/colabcola/main/docs/assets/colabcola-banner.png" alt="Colab Cola — package and run Python workloads on Google Colab" width="100%">
+</p>
+
+Colab Cola packages Python scripts, modules, dependencies, and inputs into reproducible jobs. Submit them to Google Colab, monitor execution, and recover verified results from Google Drive — without building a notebook launcher yourself.
+
+```bash
+python -m pip install colabcola
+```
+
+Requires Python 3.12+. See [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) for source installation and testing.
+
+## Quick start
+
+**1. Connect your Google account**
+
+```bash
+colabcola login --profile research
+```
+
+Colab Cola guides you through execution-project setup and authorization. New profiles use the bundled production Desktop OAuth client by default; providing your own is optional. First-time Google consent and some Console steps require your participation. [Setup guide](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md)
+
+**2. Package an existing Python workload**
+
+```bash
+colabcola package --profile research \
+  --save-colaml experiment.colaml -- python train.py
+```
+
+The packaging guide collects data, dependencies, hardware needs, outputs, and optional checkpoint configuration. It creates a `.colajob` plus a reusable `.colaml` recipe, without executing your code.
+
+**3. Run it on Colab**
+
+```bash
+colabcola run --profile research \
+  --colaml experiment.colaml \
+  --run-dir ./runs/experiment-1
+```
+
+Colab Cola checks the job and account, stages inputs, supervises the Colab runtime, publishes results to Drive, verifies recovered files, and releases the runtime it owns. Keep the supervising computer online while the run is active.
+
+To prepare offline, add `--prepare-only`. To verify launch prerequisites without uploading or allocating compute, use `--preflight-only`. Repeating the **same command with the same run directory** reconnects to the existing run rather than starting a new one.
+
+## What Colab Cola provides
+
+| Capability | Description |
+| --- | --- |
+| **Python-first jobs** | Package scripts, modules, local files, pip requirements, and wheels. |
+| **Managed runtime lifecycle** | Allocate, execute, monitor, and release Colab runtimes within declared bounds. |
+| **Durable results** | Persist logs, checkpoints, and artifacts to Google Drive with integrity verification. |
+| **Failure recovery** | Resume checkpoint-aware workloads on a replacement runtime after confirmed runtime loss. |
+| **Repeatable workflows** | Reuse `.colaml` recipes, named account profiles, and durable run journals. |
+| **Automation-friendly output** | Structured command results alongside human-readable terminal progress. |
+
+```text
+Python workload + inputs
+          │
+          ▼
+  colabcola package ──► .colajob / .colaml
+                               │
+                               ▼
+                       colabcola run
+                               │
+                               ▼
+                        Google Colab
+                               │
+                               ▼
+                  Google Drive + verified results
+```
+
+## Platform support
+
+| Host platform | Status for v0.1.0 |
+| --- | --- |
+| **Windows / PowerShell** | Live-tested: installation, login, CPU execution, artifacts, automatic checkpoint recovery, and owned-runtime cleanup. |
+| **Ubuntu via WSL2** | Previously tested for managed execution and recovery; WSL2 is optional for Windows users. |
+| **Native Linux** | Expected to work; independent release validation pending. |
+| **macOS** | Not yet supported for managed login and execution. |
+
+**Requirements:** Python 3.12 or newer, a Google account with access to Colab and Drive, and any one-time OAuth/Cloud project setup described in the [setup guide](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md). Accelerator availability depends on Google Colab. The Windows recovery acceptance test used CPU runtimes; it does **not** establish that every GPU or runtime configuration works.
+
+Checkpoint recovery is opt-in: your workload must write restorable state and accept a checkpoint manifest. A runtime lost before publishing its latest checkpoint cannot recover its unsaved in-memory progress. Compute limits are bounded requests, not guaranteed billing ceilings.
+
+## Documentation
+
+| Guide | Contents |
+| --- | --- |
+| [First-time setup](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md) | Illustrated Google account, OAuth, Cloud project, and login walkthrough. |
+| [Packaging](https://github.com/dependanz/colabcola/blob/main/docs/PACKAGING.md) | `.colajob` format, dependencies, inputs, outputs, and checkpoints. |
+| [Recipes and managed workflows](https://github.com/dependanz/colabcola/blob/main/docs/RECIPES.md) | `.colaml`, run directories, offline preparation, and automation. |
+| [Execution and recovery](https://github.com/dependanz/colabcola/blob/main/docs/LIFECYCLE.md) | Supervisor behavior, Drive persistence, failure recovery, and limits. |
+| [Legacy controller](https://github.com/dependanz/colabcola/blob/main/docs/LEGACY_CONTROLLER.md) | Earlier notebook-based/manual execution workflows. |
+| [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) | Local builds, tests, and contribution workflow. |
+| [Design](https://github.com/dependanz/colabcola/blob/main/docs/DESIGN.md) | Technical architecture and integrity contracts. |
+
+## Development
+
+Colab Cola is distributed as a Python package. Release checks cover clean wheel/source installs, complete regression tests, platform behavior, license notices, and the verified runtime lifecycle. See [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) and [Packaging](https://github.com/dependanz/colabcola/blob/main/docs/PACKAGING.md) for current details.
+
+Colab Cola is an independent project and is **not affiliated with or endorsed by Google**. Google Colab and Google Drive remain subject to their own availability, policies, and limits.

colabcola-0.1.0/README.md

@@ -0,0 +1,100 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dependanz/colabcola/main/docs/assets/colabcola-banner.png" alt="Colab Cola — package and run Python workloads on Google Colab" width="100%">
+</p>
+
+Colab Cola packages Python scripts, modules, dependencies, and inputs into reproducible jobs. Submit them to Google Colab, monitor execution, and recover verified results from Google Drive — without building a notebook launcher yourself.
+
+```bash
+python -m pip install colabcola
+```
+
+Requires Python 3.12+. See [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) for source installation and testing.
+
+## Quick start
+
+**1. Connect your Google account**
+
+```bash
+colabcola login --profile research
+```
+
+Colab Cola guides you through execution-project setup and authorization. New profiles use the bundled production Desktop OAuth client by default; providing your own is optional. First-time Google consent and some Console steps require your participation. [Setup guide](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md)
+
+**2. Package an existing Python workload**
+
+```bash
+colabcola package --profile research \
+  --save-colaml experiment.colaml -- python train.py
+```
+
+The packaging guide collects data, dependencies, hardware needs, outputs, and optional checkpoint configuration. It creates a `.colajob` plus a reusable `.colaml` recipe, without executing your code.
+
+**3. Run it on Colab**
+
+```bash
+colabcola run --profile research \
+  --colaml experiment.colaml \
+  --run-dir ./runs/experiment-1
+```
+
+Colab Cola checks the job and account, stages inputs, supervises the Colab runtime, publishes results to Drive, verifies recovered files, and releases the runtime it owns. Keep the supervising computer online while the run is active.
+
+To prepare offline, add `--prepare-only`. To verify launch prerequisites without uploading or allocating compute, use `--preflight-only`. Repeating the **same command with the same run directory** reconnects to the existing run rather than starting a new one.
+
+## What Colab Cola provides
+
+| Capability | Description |
+| --- | --- |
+| **Python-first jobs** | Package scripts, modules, local files, pip requirements, and wheels. |
+| **Managed runtime lifecycle** | Allocate, execute, monitor, and release Colab runtimes within declared bounds. |
+| **Durable results** | Persist logs, checkpoints, and artifacts to Google Drive with integrity verification. |
+| **Failure recovery** | Resume checkpoint-aware workloads on a replacement runtime after confirmed runtime loss. |
+| **Repeatable workflows** | Reuse `.colaml` recipes, named account profiles, and durable run journals. |
+| **Automation-friendly output** | Structured command results alongside human-readable terminal progress. |
+
+```text
+Python workload + inputs
+          │
+          ▼
+  colabcola package ──► .colajob / .colaml
+                               │
+                               ▼
+                       colabcola run
+                               │
+                               ▼
+                        Google Colab
+                               │
+                               ▼
+                  Google Drive + verified results
+```
+
+## Platform support
+
+| Host platform | Status for v0.1.0 |
+| --- | --- |
+| **Windows / PowerShell** | Live-tested: installation, login, CPU execution, artifacts, automatic checkpoint recovery, and owned-runtime cleanup. |
+| **Ubuntu via WSL2** | Previously tested for managed execution and recovery; WSL2 is optional for Windows users. |
+| **Native Linux** | Expected to work; independent release validation pending. |
+| **macOS** | Not yet supported for managed login and execution. |
+
+**Requirements:** Python 3.12 or newer, a Google account with access to Colab and Drive, and any one-time OAuth/Cloud project setup described in the [setup guide](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md). Accelerator availability depends on Google Colab. The Windows recovery acceptance test used CPU runtimes; it does **not** establish that every GPU or runtime configuration works.
+
+Checkpoint recovery is opt-in: your workload must write restorable state and accept a checkpoint manifest. A runtime lost before publishing its latest checkpoint cannot recover its unsaved in-memory progress. Compute limits are bounded requests, not guaranteed billing ceilings.
+
+## Documentation
+
+| Guide | Contents |
+| --- | --- |
+| [First-time setup](https://github.com/dependanz/colabcola/blob/main/docs/USER_SETUP.md) | Illustrated Google account, OAuth, Cloud project, and login walkthrough. |
+| [Packaging](https://github.com/dependanz/colabcola/blob/main/docs/PACKAGING.md) | `.colajob` format, dependencies, inputs, outputs, and checkpoints. |
+| [Recipes and managed workflows](https://github.com/dependanz/colabcola/blob/main/docs/RECIPES.md) | `.colaml`, run directories, offline preparation, and automation. |
+| [Execution and recovery](https://github.com/dependanz/colabcola/blob/main/docs/LIFECYCLE.md) | Supervisor behavior, Drive persistence, failure recovery, and limits. |
+| [Legacy controller](https://github.com/dependanz/colabcola/blob/main/docs/LEGACY_CONTROLLER.md) | Earlier notebook-based/manual execution workflows. |
+| [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) | Local builds, tests, and contribution workflow. |
+| [Design](https://github.com/dependanz/colabcola/blob/main/docs/DESIGN.md) | Technical architecture and integrity contracts. |
+
+## Development
+
+Colab Cola is distributed as a Python package. Release checks cover clean wheel/source installs, complete regression tests, platform behavior, license notices, and the verified runtime lifecycle. See [Development](https://github.com/dependanz/colabcola/blob/main/docs/DEVELOPMENT.md) and [Packaging](https://github.com/dependanz/colabcola/blob/main/docs/PACKAGING.md) for current details.
+
+Colab Cola is an independent project and is **not affiliated with or endorsed by Google**. Google Colab and Google Drive remain subject to their own availability, policies, and limits.