Skip to content

Repository files navigation

🎯 Typer Common Functions

Helper functions for Typer CLI applications.

PyPI version License: LGPL v3 Python Versions

✨ Features

  • 📝 Rich-based logging configuration
  • ⚡ Typer helper functions and utilities

📦 Installation

Available on PyPI:

pip install typer-common-functions

🚀 Usage

from typer_common_functions import set_logging, typer_unpacker

# Configure logging with Rich
set_logging(verbose=True)

# Create CLI commands with type hints
@typer_unpacker
def hello(name: str) -> str:
    return f"Hello {name}!"

🛠️ Development

📋 Requirements

  • 🐍 Python 3.8+
  • 🏗️ Hatch for project management
  • UV for dependency management
  • 🐳 Dev Container support (optional)

⚙️ Setup

# Install tools
uv pip install hatch pre-commit
pre-commit install

# Create dev environment
hatch shell

# Run tests
hatch run dev:test

# Run linting
hatch run dev:lint

# Run formatters
hatch run dev:format

🔍 Code Quality

  • ✅ Testing: pytest with coverage
  • 🔬 Linting: flake8, pylint, mypy
  • 🎨 Formatting: black, isort
  • 🛡️ Security: bandit
  • 🔄 Git hooks: pre-commit

📦 Release Process

  1. 🔖 Run "Version Bump" workflow in GitHub Actions
  2. 🎯 Choose version bump type
  3. 👀 Review and merge the created PR
  4. 🚀 Automated release and PyPI publish on merge

📄 License

LGPL-3.0-or-later - see LICENSE

About

Common Functions that Wrap around Typer CLI

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages