Skip to main content

Harmonises Jupyter and Colab notebook environments for consistent paths, imports, and working directories

Project description

colocal

Colab or local — same behaviour, same results.

colocal is a lightweight utility that harmonises notebook environments across Google Colab and local Jupyter.

It takes care of paths, imports, and working directories automatically, so your notebooks behave consistently no matter where you run them.


✨ Features

  • Seamless dual support → Detects whether you’re in Colab or Jupyter and adjusts automatically.
  • Clean imports → Adds your repository root to sys.path.
  • Consistent working directory → Sets cwd to the notebook’s folder, avoiding ../../ hacks.
  • Branch-aware in Colab → Parses the Colab badge, checks out the correct branch, and mirrors the repo structure.
  • Reproducibility → Run the same notebook in Colab or locally with identical behaviour.

🚀 Usage

import colocal
colocal.setup()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colocal-2025.10.28.1507.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

colocal-2025.10.28.1507-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file colocal-2025.10.28.1507.tar.gz.

File metadata

  • Download URL: colocal-2025.10.28.1507.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for colocal-2025.10.28.1507.tar.gz
Algorithm Hash digest
SHA256 20da7603895baf884c8da925b242da8972319d6a35c586af1385f95534cf3cac
MD5 e208424042d7a0840dd11f4d70c6e350
BLAKE2b-256 052fc265a084d66d6fde344adfbda032adb865f4c4ece00f4b01aaec7e7c90ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for colocal-2025.10.28.1507.tar.gz:

Publisher: publish.yml on project-ida/colocal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file colocal-2025.10.28.1507-py3-none-any.whl.

File metadata

File hashes

Hashes for colocal-2025.10.28.1507-py3-none-any.whl
Algorithm Hash digest
SHA256 766381c27e0c0974cc20e21ae99f42aa4785d66b51115f1c858a18a5cc26a9dc
MD5 4867173b18defefe25139675ff2d760b
BLAKE2b-256 b1ff5d192b293d94bed049178597fcae50ea478b762b29258af7765b57f24d0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for colocal-2025.10.28.1507-py3-none-any.whl:

Publisher: publish.yml on project-ida/colocal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page