__init__.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# oct/install/__init__.py
 
"""
Purpose
-------
Package marker for ``oct install`` (B1.4): a wrapper around
``pip install -e`` with safety checks that prevent the most common
operator-error class — running an editable install in the wrong
terminal window, against the wrong venv, or from a worktree where the
install would shadow another tree.
 
Responsibilities
----------------
- Hold the public ``oct_install`` Click command, mounted by
  :mod:`oct.cli`.
 
Diagnostics
-----------
Domain: INSTALL
Levels:
    L1 — errors (pip subprocess failure, refusal diagnostics)
    L2 — lifecycle (preflight start/end, install start/end)
    L3 — details (venv path, target path, shadow detection)
 
Contracts
---------
- The package contains no business logic; the command lives in
  :mod:`oct.install.oct_install`.
"""