Code manual

Entrypoints

• pipenv-unlock

• drain-swamp

• scm-version

Snippet

• drain_swamp_snippet.Snip

• drain_swamp_snippet.ReplaceResult

Snippet base package drain-swamp-snippet has class Snip and enum ReplaceResult

Dependency locking

• lock infile

• lock inspect

• lock util

• snippet dependencies

drain-swamp utils

• version semantic

• Sphinx conf

• Igor.py utils

Core

• Constants

• Version file

• Constants maybe

• Exceptions

• Check type

• pyproject.toml read

• pyproject.toml venvs

• pyproject.toml parser

• Package metadata

• Package installed

• Run command

Version file

• Overrides

• Dump

drain-swamp has built-in build plugins and is extendable.

Note

code isolation

Lets not reinvent the wheel.

Care is taken to leverage the upstream codebases. Counter-intuitively, there is less reliance on the drain-swamp codebase

Core

• config_settings

• Patch pyproject reading

Plugin manager

• PM subpackage

• PM constants

• Hook implementation markers

• Hook specs

• Plugin Manager

Plugins

• Plugins subpackage

• SCM version

Build integration

• Get version

• Infer version

• Version keyword

drain_swamp.__all__: tuple[str, str, str, str] = ("PyProjectTOMLParseError", "BackendNotSupportedError", "PyProjectTOMLReadError", "MissingRequirementsFoldersFiles")

Package level exports are limited to just custom exceptions. This was originally done to avoid unexpected side effects