pun

This is a pun.

Table of Contents

• Screenshots
• Installation
• Usage
• Support
• Motivation
• Features
• About
• Author
• Analysis
• Contributing
• Development
• Releasing
• Credits
• License
• Changelog

Screenshots

Installation

pun is a standalone end-user tool whose primary command is pun. Install it into an isolated environment:

uv tool install pun

Or run it without installing with uvx pun. See the installation docs for pipx and from-source options.

Verify the installation

The package root is importable after installation:

>>> from pun import __doc__
>>> isinstance(__doc__, str)
True

Usage

CLI

pun version
pun info

TUI

pun interactive

An interactive terminal user interface displays project information. Press 'q' to exit.

Support ❤️

If you have any questions or need help, feel free to open an issue on the GitHub repository.

Motivation

Features

• CLI Application: Command-line interface built with Typer
• TUI Application: Terminal user interface built with Textual
• Configuration Management: Type-safe settings using Pydantic

About

Author 🫅

This project is maintained by Hasan Sezer Taşan, It's me 👋

Analysis

• Snyk Python Package Health Analysis
• Libraries.io - PyPI
• Safety DB
• PePy Download Stats
• PyPI Download Stats
• Pip Trends Download Stats
• PyPI Map Dependency Graph

Contributing ❤️

Any contributions are welcome! Please follow the Contributing Guidelines to contribute to this project.

Development 🧰

See the Contributing Guidelines for local setup, the common development tasks (exposed via mise), building and previewing the documentation, and the VS Code debugging configurations.

Releasing

Versioning and releases are automated with release-please, driven by Conventional Commit PR titles squash-merged into main. release-please maintains a release PR that bumps the version and CHANGELOG.md; merging it tags the release and publishes to PyPI. See the Contributing Guidelines for the commit conventions, and the Repository setup guide for one-time configuration and optional post-launch integrations such as a social preview, downstream packaging, and Repology.

Pause merges that change .github/workflows/, including Renovate action-pin updates, from merging a release PR until the entire Release run finishes. Workflow differences between the release commit and current main can block tag or release creation with a 403 when using GITHUB_TOKEN. See Release recovery for prevention and recovery steps.

For adoption or template-update reconciliation, ask your agent to "audit this template adoption/update against our existing project behavior". The shipped template-adoption skill also supports audits after an update was applied. It compares workflow behavior, required checks, custom tooling, and documentation, and asks before consequential cleanup. Its prek-workflow example shows why duplicate commands alone do not justify removing a workflow. Use the sibling repo-setup skill for repository settings and release setup.

Credits

This package was created with Copier and the hasansezertasan/copier-pyproject project template.

License 📜

This project is licensed under the MIT License.

Changelog 📝

For a detailed list of changes, please refer to the CHANGELOG.