oct
Loading...
Searching...
No Matches
__init__.py
Go to the documentation of this file.
1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3# oct/install/__init__.py
4
5"""
6Purpose
7-------
8Package marker for ``oct install`` (B1.4): a wrapper around
9``pip install -e`` with safety checks that prevent the most common
10operator-error class - running an editable install in the wrong
11terminal window, against the wrong venv, or from a worktree where the
12install would shadow another tree.
13
14Responsibilities
15----------------
16- Hold the public ``oct_install`` Click command, mounted by
17 :mod:`oct.cli`.
18
19Diagnostics
20-----------
21Domain: INSTALL
22Levels:
23 L1 - errors (pip subprocess failure, refusal diagnostics)
24 L2 - lifecycle (preflight start/end, install start/end)
25 L3 - details (venv path, target path, shadow detection)
26 L4 - (none) the package root re-exports only; the command reports
27
28Contracts
29---------
30- The package contains no business logic; the command lives in
31 :mod:`oct.install.oct_install`.
32
33Dependencies
34------------
35- oct.core.diagnostics (_dbg structured logger, imported but not called)
36"""
37
38# OCT-LINT: disable-file=dbg_usage reason="Plan 263: a re-export package root with no function or method, so any _dbg call here would run before oc_diagnostics.init() and add a RuntimeWarning to every oct invocation"
39from oct.core.diagnostics import _dbg