Metadata-Version: 2.4
Name: punkin
Version: 0.2.1
Summary: Transform your entire package tree into a self‑inflicted, fear‑addicted CLI.
Author-email: David Seaward <72779-lofidevops@users.noreply.gitlab.com>
License: Apache-2.0
Keywords: cli,fire,submodules
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: fire>=0.7.1
Provides-Extra: test
Requires-Dist: coverage>=7.5.0; extra == 'test'
Requires-Dist: pytest>=8.2.0; extra == 'test'
Description-Content-Type: text/markdown

<!--
SPDX-License-Identifier: Apache-2.0
SPDX-FileCopyrightText: Copyright 2026 David Seaward and contributors
-->

# punkin'

Punkin' is a [Fire](https://pypi.org/project/fire/) starter
that transforms your entire package tree into a self‑inflicted, fear‑addicted CLI.
Use with caution.

## Usage

Create `_cli.py` in your src root:

```python
import fire
import package  # your package
from punkin import instigator

def main():
    fire.Fire(instigator(package))

if __name__ == "__main__":
    main()
```

## Development environment

## Release

First, push the new tag:

```sh
git tag -a 2.0.0 -m "Version 2.0.0"
git push origin 2.0.0
```

Then visit https://gitlab.com/lfdo/punkin/-/pipelines and trigger the `publish` job.

# Sharing and contributions

```
punkin'
https://lofidevops.neocities.org
Copyright 2026 David Seaward and contributors
SPDX-License-Identifier: Apache-2.0
```

Shared under Apache-2.0. We adhere to the Contributor Covenant 2.1, and
certify origin per DCO 1.1 with a signed-off-by line. Contributions under the
same terms are welcome.

Submit security and conduct issues as private tickets. Sign commits with
`git commit --signoff`.

# Colophon

Best enjoyed with 1990s UK electronica.
