From f868ed82a362fd41fd89a30bc06e0e53cabda9c3 Mon Sep 17 00:00:00 2001
From: Jen Bradley <55467578+janbridley@users.noreply.github.com>
Date: Mon, 16 Sep 2024 15:26:35 -0400
Subject: [PATCH] Release/0.9.0 (#239)
* Update to use bump-my-version
* Fix bumpversion config
* Update bumpversion config
* Remove prior bumpversion cfg
* Bump version
* Update ChangeLog.rst
* pre-commit autoupdate
* Fix ruff config in pyproject.toml
* Remove setup.cfg
* Update version for test_io files
---
.pre-commit-config.yaml | 4 ++--
ChangeLog.rst | 9 +++++++--
coxeter/__init__.py | 2 +-
doc/source/conf.py | 4 ++--
pyproject.toml | 24 ++++++++++++++++++++----
setup.cfg | 14 --------------
tests/control/convex_polyhedron.obj | 2 +-
tests/control/convex_polyhedron.off | 2 +-
tests/control/convex_polyhedron.ply | 2 +-
tests/control/convex_polyhedron.vtk | 2 +-
tests/control/polyhedron.obj | 2 +-
tests/control/polyhedron.off | 2 +-
tests/control/polyhedron.ply | 2 +-
tests/control/polyhedron.vtk | 2 +-
14 files changed, 40 insertions(+), 33 deletions(-)
delete mode 100644 setup.cfg
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index e016bd4e..b31b8f52 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -22,7 +22,7 @@ repos:
- id: check-yaml
- id: requirements-txt-fixer
- repo: https://github.com/glotzerlab/fix-license-header
- rev: v0.3.2
+ rev: v0.4.0
hooks:
- id: fix-license-header
name: Fix License Headers (Python)
@@ -35,7 +35,7 @@ repos:
- --add=This file is from the coxeter project, released under the BSD 3-Clause License.
- --keep-before=#!
- repo: https://github.com/astral-sh/ruff-pre-commit
- rev: v0.5.0
+ rev: v0.6.5
hooks:
# Run the linter.
- id: ruff
diff --git a/ChangeLog.rst b/ChangeLog.rst
index 2b0cbb9f..a2e3a404 100644
--- a/ChangeLog.rst
+++ b/ChangeLog.rst
@@ -1,20 +1,25 @@
The format is based on `Keep a Changelog `__.
This project adheres to `Semantic Versioning `__.
+
v0.x.x - 20xx-xx-xx
-------------------
+v0.9.0 - 2024-09-13
+-------------------
+
Breaking
~~~~~
-- [breaking] The hidden ``TabulatedShapeFamily`` class has been removed, with functionality moved to ``TabulatedGSDShapeFamily``.
+- The private ``TabulatedShapeFamily`` class has been removed, with functionality moved to ``TabulatedGSDShapeFamily``.
Added
~~~~~
- ``TabulatedGSDShapeFamilies`` are now iterable, allowing easier access to shapes.
- New ``UniformPrismFamily``, ``UniformAntiprismFamily``, ``UniformPyramidFamily``, and ``UniformDipyramidFamily``
-- New documentation to assist users initialize common geometries.
+- New documentation to help users initialize common geometries.
+- New methods to export Polyhedra as OBJ, OFF, STL, PLY, VTK, X3D, and HTML files.
Changed
~~~~~~~
diff --git a/coxeter/__init__.py b/coxeter/__init__.py
index 6ccb9fc9..2dea5c7c 100644
--- a/coxeter/__init__.py
+++ b/coxeter/__init__.py
@@ -16,7 +16,7 @@
applications such as inertia tensors.
"""
-__version__ = "0.8.0"
+__version__ = "0.9.0"
from . import families, io, shapes
from .shape_getters import from_gsd_type_shapes
diff --git a/doc/source/conf.py b/doc/source/conf.py
index b4c3151a..1ff85911 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,8 +22,8 @@
author = "Vyas Ramasubramani"
# The full version, including alpha/beta/rc tags
-version = "0.8.0"
-release = "0.8.0"
+version = "0.9.0"
+release = "0.9.0"
# -- General configuration ---------------------------------------------------
diff --git a/pyproject.toml b/pyproject.toml
index 138c2199..f76a413b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "coxeter"
-version = "0.8.0"
+version = "0.9.0"
requires-python = ">=3.8"
description = "Tools for creating and manipulating shapes."
readme = "README.rst"
@@ -73,14 +73,14 @@ ignore =[
"D107", # __init__ methods don't require documentation.
]
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
convention = "numpy"
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
known-third-party = ["hypothesis", "pytest"]
known-first-party = ["conftest", "coxeter", "utils"]
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
"coxeter/__init__.py" = ["F401"]
"tests/*" = ["D", "B018"]
"setup.py" = ["D"]
@@ -90,3 +90,19 @@ known-first-party = ["conftest", "coxeter", "utils"]
[tool.ruff.format]
quote-style = "double"
indent-style = "space"
+
+[tool.bumpversion]
+# Configuration for https://github.com/callowayproject/bump-my-version
+tag = false
+commit = false
+message = "Bump version: {current_version} → {new_version}"
+
+[[tool.bumpversion.files]]
+filename="pyproject.toml"
+[[tool.bumpversion.files]]
+filename="doc/source/conf.py"
+[[tool.bumpversion.files]]
+filename="coxeter/__init__.py"
+
+# [tool.distutils.bdist_wheel]
+# python-tag = "py3"
diff --git a/setup.cfg b/setup.cfg
deleted file mode 100644
index cbee67bd..00000000
--- a/setup.cfg
+++ /dev/null
@@ -1,14 +0,0 @@
-[bumpversion]
-current_version = 0.8.0
-commit = False
-tag = True
-message = Bump up to version {new_version}.
-
-[bdist_wheel]
-python-tag = py3
-
-[bumpversion:file:coxeter/__init__.py]
-
-[bumpversion:file:doc/source/conf.py]
-
-[bumpversion:file:pyproject.toml]
diff --git a/tests/control/convex_polyhedron.obj b/tests/control/convex_polyhedron.obj
index 4d565655..f266a66f 100644
--- a/tests/control/convex_polyhedron.obj
+++ b/tests/control/convex_polyhedron.obj
@@ -1,4 +1,4 @@
-# wavefront obj file written by Coxeter version 0.8.0
+# wavefront obj file written by Coxeter version 0.9.0
# ConvexPolyhedron
v 0.0 0.0 1.2065695672061325
diff --git a/tests/control/convex_polyhedron.off b/tests/control/convex_polyhedron.off
index f7d12c2a..bf98fc60 100644
--- a/tests/control/convex_polyhedron.off
+++ b/tests/control/convex_polyhedron.off
@@ -1,5 +1,5 @@
OFF
-# OFF file written by Coxeter version 0.8.0
+# OFF file written by Coxeter version 0.9.0
# ConvexPolyhedron
11 f11 20
0.0 0.0 1.2065695672061325
diff --git a/tests/control/convex_polyhedron.ply b/tests/control/convex_polyhedron.ply
index b657fb12..905ebe57 100644
--- a/tests/control/convex_polyhedron.ply
+++ b/tests/control/convex_polyhedron.ply
@@ -1,6 +1,6 @@
ply
format ascii 1.0
-comment PLY file written by Coxeter version 0.8.0
+comment PLY file written by Coxeter version 0.9.0
comment ConvexPolyhedron
element vertex 11
property float x
diff --git a/tests/control/convex_polyhedron.vtk b/tests/control/convex_polyhedron.vtk
index 6abecc9f..512b9548 100644
--- a/tests/control/convex_polyhedron.vtk
+++ b/tests/control/convex_polyhedron.vtk
@@ -1,5 +1,5 @@
# vtk DataFile Version 3.0
-ConvexPolyhedron created by Coxeter version 0.8.0
+ConvexPolyhedron created by Coxeter version 0.9.0
ASCII
DATASET POLYDATA
POINTS 11 float
diff --git a/tests/control/polyhedron.obj b/tests/control/polyhedron.obj
index 9a814946..a4919359 100644
--- a/tests/control/polyhedron.obj
+++ b/tests/control/polyhedron.obj
@@ -1,4 +1,4 @@
-# wavefront obj file written by Coxeter version 0.8.0
+# wavefront obj file written by Coxeter version 0.9.0
# Polyhedron
v 0.0 0.0 1.2065695672061325
diff --git a/tests/control/polyhedron.off b/tests/control/polyhedron.off
index 5456db93..ba0ec6bd 100644
--- a/tests/control/polyhedron.off
+++ b/tests/control/polyhedron.off
@@ -1,5 +1,5 @@
OFF
-# OFF file written by Coxeter version 0.8.0
+# OFF file written by Coxeter version 0.9.0
# Polyhedron
11 f11 20
0.0 0.0 1.2065695672061325
diff --git a/tests/control/polyhedron.ply b/tests/control/polyhedron.ply
index 571cdaa9..9badc20f 100644
--- a/tests/control/polyhedron.ply
+++ b/tests/control/polyhedron.ply
@@ -1,6 +1,6 @@
ply
format ascii 1.0
-comment PLY file written by Coxeter version 0.8.0
+comment PLY file written by Coxeter version 0.9.0
comment Polyhedron
element vertex 11
property float x
diff --git a/tests/control/polyhedron.vtk b/tests/control/polyhedron.vtk
index a71c67d1..c4926dd0 100644
--- a/tests/control/polyhedron.vtk
+++ b/tests/control/polyhedron.vtk
@@ -1,5 +1,5 @@
# vtk DataFile Version 3.0
-Polyhedron created by Coxeter version 0.8.0
+Polyhedron created by Coxeter version 0.9.0
ASCII
DATASET POLYDATA
POINTS 11 float