Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 43 additions & 5 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,13 @@ poetry run python -m build
ls dist/
```

Test the built package rather than the source tree:

Test the built wheel rather than running from the source tree:
```bash
uv tool install ./dist/splinter3d_style-X.Y.Z-py3-none-any.whl
splinter3d_style
uv tool uninstall splinter3d_style
```
or
```bash
pipx install ./dist/splinter3d_style-X.Y.Z-py3-none-any.whl
splinter3d_style
Expand All @@ -49,27 +54,60 @@ deactivate

`X.Y.Z` is a placeholder. Use the actual filename created in `dist/`, or install the first built wheel directly:

```bash
uv tool install "$(ls dist/*.whl | head -n 1)"
```
or
```bash
pipx install "$(ls dist/*.whl | head -n 1)"
```

## Install From A Release
## Run Without Installing

Install a published release artifact with `pipx`:
```bash
uvx --from git+https://github.com/Splinter3D/StyleCheck splinter3d_style
```
or
```bash
pipx run --spec git+https://github.com/Splinter3D/StyleCheck splinter3d_style
```

## Install From Git

```bash
uv tool install git+https://github.com/Splinter3D/StyleCheck
```
or
```bash
pipx install git+https://github.com/Splinter3D/StyleCheck
```
then
```bash
splinter3d_style
```

## Update From A Release

Update a the package with pipx
Update a the package with the package manager you chose for install

```bash
uv tool upgrade splinter3d_style
```
or
```bash
pipx upgrade splinter3d_style
```

## Remove the Installed Tool

```bash
uv tool uninstall splinter3d_style
```
or
```bash
pipx uninstall splinter3d_style
```

## Use With pre-commit

Add this repository and a release tag to your `.pre-commit-config.yaml`:
Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## v0.2.3 (2026-07-09)

### Fix

- updated installation documentation

## v0.2.2 (2026-07-08)

## v0.2.2-rc.1 (2026-07-08)

### Fix
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "splinter3d_style"
version = "0.2.2rc1"
version = "0.2.3"
description = "A style checker for Splinter3D projects."
readme = ".github/README.md"
requires-python = ">=3.10,<4.0"
Expand Down