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.11.6.1303.tar.gz (3.2 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.11.6.1303-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for colocal-2025.11.6.1303.tar.gz
Algorithm Hash digest
SHA256 bd8fc140c01dcb2a61801a91bd9b5c7683869fee6151be7b178f9c42eb816c39
MD5 99dc7375475e4b46e8e8095a16000221
BLAKE2b-256 18a20e8d3ef4d9020e5bbea49c642288cf8bd0a2aef97d3727da1bd5fcc3665d

See more details on using hashes here.

Provenance

The following attestation bundles were made for colocal-2025.11.6.1303.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.11.6.1303-py3-none-any.whl.

File metadata

File hashes

Hashes for colocal-2025.11.6.1303-py3-none-any.whl
Algorithm Hash digest
SHA256 c3c39b2d86a656653441fd4f5a9e359c5cb0fd0812e70e055ee691ba9d2ff150
MD5 5e4e700efa527918451613e1dbb8a37e
BLAKE2b-256 bcdf1aafe8ae1c791ba7fbc807efa01859e0cfa4801298b20bffdc1aa1cef02a

See more details on using hashes here.

Provenance

The following attestation bundles were made for colocal-2025.11.6.1303-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