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, so import libs always works.
  • 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.9.17.339.tar.gz (2.9 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.9.17.339-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for colocal-2025.9.17.339.tar.gz
Algorithm Hash digest
SHA256 19585a71261605f8250c7ead5d60aedd88fa25c1fb6ee2e49f4f1300cbe566e5
MD5 5223ac73440997130b94e653258daa83
BLAKE2b-256 bba9430237fe165ba3fcb043f4587e23c34e86501931fc1d0ee658755147d416

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for colocal-2025.9.17.339-py3-none-any.whl
Algorithm Hash digest
SHA256 57eb4b9e5d943bbf3c9c229316a54a9d7776e0e5cdc066580f3cbf67768509b8
MD5 324fd7d37f818679eead2d493b2dc6b1
BLAKE2b-256 d66f6cd83d643b43e074689815e929a1c67a5bfb70e977d35d5a522b1e132adf

See more details on using hashes here.

Provenance

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