buvis-pybase 0.10.0

Foundation of BUVIS python projects

buvis-pybase

Foundation library for BUVIS Python projects. Provides configuration management, filesystem utilities, adapters for external tools, and string manipulation.

Install

pip install buvis-pybase

Features

• Configuration - Pydantic settings with Click helpers (buvis_options, get_settings)
• Adapters - Shell, UV, Poetry, JIRA, Console wrappers
• Filesystem - Cross-platform file metadata, directory operations
• Formatting - String slugify, abbreviations, case conversion

Usage

import click
from buvis.pybase.configuration import buvis_options, get_settings, GlobalSettings
from buvis.pybase.adapters import ShellAdapter, ConsoleAdapter
from buvis.pybase.filesystem import DirTree
from buvis.pybase.formatting import StringOperator

# Config via Click (adds --debug/--log-level/--config-dir/--config)
@click.command()
@buvis_options  # Use settings_class=CustomSettings for tool-specific models
@click.pass_context
def main(ctx: click.Context) -> None:
    settings = get_settings(ctx)  # GlobalSettings by default
    click.echo(f"Debug: {settings.debug}")

# Shell commands
shell = ShellAdapter()
stderr, stdout = shell.exe("ls -la")

# Console output
console = ConsoleAdapter()
console.success("Done")

# Filesystem
DirTree.remove_empty_directories("/path/to/clean")

# Strings
slug = StringOperator.slugify("Hello World!")  # "hello-world"

Development

uv sync --all-groups                        # install deps
pre-commit install --hook-type pre-commit --hook-type post-commit  # setup hooks
uv run pytest                               # run tests

Release

Releases via GitHub Actions (manual trigger):

1. Go to Actions → Release workflow → Run workflow
2. Choose prerelease (test.pypi only) or release (both pypis + GitHub release)

Version determined from conventional commits (feat: → minor, fix: → patch).

uv run semantic-release version --print --noop  # preview next version

See dev/docs/versioning.md for details.

License

MIT