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.132.tar.gz (2.8 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.132-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: colocal-2025.9.17.132.tar.gz
  • Upload date:
  • Size: 2.8 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.132.tar.gz
Algorithm Hash digest
SHA256 3be6545159e3528c20069ab14c6e9360e679b1aa860dd0963c720d74b78ab487
MD5 1c9c04806eaa9ad0d043883eabf72f47
BLAKE2b-256 1d8b525597d0c48e7cea85a87f6110b8a3cb00449802b31023b38b2c796b3b21

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for colocal-2025.9.17.132-py3-none-any.whl
Algorithm Hash digest
SHA256 1a9c0398380385fe20964736265df499897ff148e818165f5a67b27195dd839f
MD5 f04c5bcb38c912bfce9452aa41367a8a
BLAKE2b-256 8df8c707bc8ff84255f1ca5e8e339a3b31cd8d288b7ab6c5359ab4f694af4381

See more details on using hashes here.

Provenance

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