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.2.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.2-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: typer_common_functions-0.1.2.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for typer_common_functions-0.1.2.tar.gz
Algorithm Hash digest
SHA256 984cb2bbd7dc514e8ba8ffef4536b9ccbb0139dfb29308632996bb0cfd6fa95e
MD5 6b3c0e1e62cbdd7c5df6097eb122652c
BLAKE2b-256 916e5481e3d30489beeb7ad115fee4332a59a03d6eb085e8d24789719b7f8200

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for typer_common_functions-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a825c30f426cb85cb72ca0e7b29d18dee800bea6fb8b7287579d313ad50c84fd
MD5 b68250b62a4a5df8c5f05a56d557ee3f
BLAKE2b-256 ba48bddd751748c933cc514438020a9c702da60251f5d7896b60bd50c1f975e9

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