Skip to main content

Commonly used Functions around the Typer CLI Library

Project description

🎯 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typer_common_functions-0.1.3.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typer_common_functions-0.1.3-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file typer_common_functions-0.1.3.tar.gz.

File metadata

  • Download URL: typer_common_functions-0.1.3.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for typer_common_functions-0.1.3.tar.gz
Algorithm Hash digest
SHA256 40b7766ac40b5e3a8b38b958f3e7cbdfb821d1412da47cc24580a49525c3dd40
MD5 cc9c2e5b2acc1ba5ad5566194a048173
BLAKE2b-256 2816ba97b08dfcfbf20f050e5c2054c52a1f8be3a20a748558ac0990a000139e

See more details on using hashes here.

File details

Details for the file typer_common_functions-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for typer_common_functions-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 03dd31f31165f34a86ca22b0bd1b713d57f2b65ced9c6ce79cfbc25d024a3633
MD5 eeb6bb4e5e3dbbc1f46c7644f6a17c24
BLAKE2b-256 ab93e51707add865ec7ca9e0783cdbdd071cfbe2fc04d8e8eccda4e6d634e371

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page