api

The commands and respective options

Your howto.txt file informs when to use these commands

version

command	desc
scm-version get	get scm version 0.0.1post0.dev4+g123456-d20241212
drain-swamp tag	get version from version file 0.0.1post0
scm-version write	write semantic version str to version file
drain-swamp pretag	Print/fix a semantic version str

Version file

Update package docs

command	desc
drain-swamp seed	called immediately before drain-swamp edits
drain-swamp edits	updates doc?/conf.py, NOTICE.txt, and CHANGES.rst
drain-swamp list	list snippets in doc?/conf.py

Updating changelog

Dependency locks

command	desc
pipenv-unlock is_lock	0 is locked 1 is unlocked
pipenv-unlock lock	same as pip-compile. Creates .lock files
pipenv-unlock unlock	recursively assembles .in –> .unlock files
pipenv-unlock refresh	creates/refreshes package dependency lock .lnk symlinks updates pyproject.toml dependencys’ suffix

Dependencies

Misc

command	desc
drain-swamp cheats	Prints helpful notes aids in kitting and publishing

Deprecated / outdated

command	desc
drain-swamp build	previous build package command
drain-swamp current	prior impl of scm-version current