Metadata-Version: 2.3
Name: but-cli
Version: 0.1.2
Summary: A useful cli for Blender
Author: HoppouDev
Author-email: HoppouDev <me@hoppou.dev>
Requires-Dist: bpy>=5.2.2
Requires-Dist: loguru>=0.7.3
Requires-Dist: rich>=15.0.0
Requires-Dist: typer>=0.27.2
Requires-Python: >=3.13
Description-Content-Type: text/markdown

<div align="center">

# BUT

A Blender utility built to accelerate workflows.

<br>

[![Built for Blender](https://img.shields.io/badge/built%20for-Blender-E87D0D?style=for-the-badge&logo=blender&logoColor=white)](https://www.blender.org/)
[![Built with Python](https://img.shields.io/badge/built%20with-Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
[![Packaged with uv](https://img.shields.io/badge/packaged%20with-uv-DE5FE9?style=for-the-badge&logo=uv&logoColor=white)](https://docs.astral.sh/uv/)
[![Published to PyPI](https://img.shields.io/badge/published%20to-PyPI-3775A9?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/but-cli/)
[![CI](https://img.shields.io/github/actions/workflow/status/Hoppou-Legion-Gateway/but/tests.yml?branch=main&style=for-the-badge&logo=githubactions&logoColor=white&label=CI)](https://github.com/Hoppou-Legion-Gateway/but/actions/workflows/tests.yml)

</div>

<br>

## Features

- Empty blender project creation

## Requirements

Ensure that you meet following minimum requirements before installing:

- Python 3.13.\*
- Blender >= 5.2.2
- Unity >= 2019.2.1f1

> [!NOTE]
> Unity is only required to install the Unity package

## Install

```sh
uv tool install --python 3.13 but-cli
```

## Usage

```sh
# Show help for command
uv run but --help

# Test
uv run pytest

# Build
uv build
```

## Releasing

Bump the version and push to `main`. When `v<version>` doesn't exist yet, the
release workflow publishes to [PyPI](https://pypi.org/project/but-cli/) and
then creates the tag and GitHub release.

```sh
uv version --bump patch   # or minor / major
git commit -am "chore: release v$(uv version --short)"
git push
```

Release notes are generated by [git-cliff](https://git-cliff.org) from the
[conventional commit](https://www.conventionalcommits.org) messages since the
previous tag (config: `cliff.toml`). Preview them before bumping:

```sh
git cliff --unreleased --tag v0.2.0
```

## License

This project is licensed under the MIT license. Refer to [LICENSE.md](LICENSE.md)
