🔖 Changelog entry for v0.0.1 (#50)

* ⬆️ Bump cog3pio from 0.0.1b5 to 0.0.1

Bumps [cog3pio](https://github.com/weiji14/cog3pio) from 0.0.1b5 to 0.0.1.
- [Release notes](https://github.com/weiji14/cog3pio/releases)
- [Changelog](https://github.com/weiji14/cog3pio/blob/main/docs/changelog.md)
- [Commits](0.0.1b5...0.0.1)

* 🩹 Minor tweak to put square brackets around version no

Should have done this in #48, oh well. Also fixed an incorrect regex replacement with an extra |

* 🔖 Changelog entry for v0.0.1

First patch release of cog3pio.

* 📝 Last minute minor doc changes

Changing installation instructions to point to packages on official registries (crates.io/PyPI) that should work once release is published. Pre-emptively pointing to docs.rs page, and fixing some links in the quickstart page.

* 📄 PEP 639 license and license-files, update classifiers

Xref https://peps.python.org/pep-0639. Also updated classifiers from Alpha to Beta status, added topics, OSes and updated programming languages.

* ✏️ Typo on https url

Remove extra colon

Author: weiji14

.release-plz.toml

@@ -12,7 +12,7 @@ All notable changes to this project will be documented in this file.\n
 body = """
 ---\n
 {% if version %}\
-    ## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
 {% else %}\
     ## Unreleased
 {% endif %}\
@@ -41,7 +41,7 @@ body = """
 {%- if remote.contributors %}
   ### 🧑‍🤝‍🧑 Contributors
   {% for contributor in remote.contributors %}
-    - [@{{ contributor.username }}](https:://github.com/{{ contributor.username }})
+    - [@{{ contributor.username }}](https://github.com/{{ contributor.username }})
   {%- endfor %}
   {% raw %}\n{% endraw %}\
 {% endif -%}
@@ -65,7 +65,7 @@ commit_preprocessors = [
     { pattern = ':heavy_minus_sign:', replace = "➖" },
     { pattern = ':heavy_plus_sign:', replace = "➕" },
     { pattern = ':lock:', replace = "🔒️" },
-    { pattern = ':loud_sound:', replace = "🔊|" },
+    { pattern = ':loud_sound:', replace = "🔊" },
     { pattern = ':memo:', replace = "📝" },
     { pattern = ':pushpin:', replace = "📌" },
     { pattern = ':recycle:', replace = "♻️" },

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cog3pio"
-version = "0.0.1-beta.5"
+version = "0.0.1"
 edition = "2024"
 license = "MIT OR Apache-2.0"
 rust-version = "1.85.0"

Cargo.toml

@@ -1,6 +1,7 @@
 # API Reference
 
-These are the Python docs for `cog3pio`.
+These are the Python docs for `cog3pio`, for the Rust docs, see
+<https://docs.rs/cog3pio>.
 
 ## DLPack
 

docs/api.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 ---
 
-## Unreleased
+## [0.0.1] - 2025-06-28
 
 ### <!-- 0 --> 🌈 Highlights
 
@@ -13,6 +13,7 @@ All notable changes to this project will be documented in this file.
 
 ### <!-- 1 --> ✨ Features
 
+- ✨ Support decoding ZSTD compressed and half-precision TIFFs ([#46](https://github.com/weiji14/cog3pio/pull/46))
 - ✨ Support reading 3-band RGB images ([#31](https://github.com/weiji14/cog3pio/pull/31))
 - ✨ Support reading uint/int/float dtypes ([#18](https://github.com/weiji14/cog3pio/pull/18))
 - ✨ Support reading multi-band GeoTIFF files ([#13](https://github.com/weiji14/cog3pio/pull/13))
@@ -31,10 +32,13 @@ All notable changes to this project will be documented in this file.
 
 ### <!-- 4 --> 📝 Documentation
 
+- 📝 Move installation and example commands into separate pages ([#47](https://github.com/weiji14/cog3pio/pull/47))
 - 📝 Initialize Python documentation page ([#35](https://github.com/weiji14/cog3pio/pull/35))
 
 ### <!-- 5 --> 🧰 Maintenance
 
+- 👷 GitHub Actions CI workflow to publish to crates.io ([#49](https://github.com/weiji14/cog3pio/pull/49))
+- 🔧 Switch changelog generator config from git-cliff to release-plz ([#48](https://github.com/weiji14/cog3pio/pull/48))
 - 📌 Unpin sphinx-ext-mystmd in docs extras ([#44](https://github.com/weiji14/cog3pio/pull/44))
 - 🔊 Enable verbose logging for pypa/gh-action-pypi-publish ([#42](https://github.com/weiji14/cog3pio/pull/42))
 - 👷 Upload to TestPyPI on prerelease and release tags ([#40](https://github.com/weiji14/cog3pio/pull/40))
@@ -54,3 +58,7 @@ All notable changes to this project will be documented in this file.
 - 👷 Setup benchmark workflow with pytest-codspeed ([#4](https://github.com/weiji14/cog3pio/pull/4))
 - 👷 Setup GitHub Actions Continuous Integration tests ([#2](https://github.com/weiji14/cog3pio/pull/2))
 - 🌱 Initialize Cargo.toml and pyproject.toml with maturin ([#1](https://github.com/weiji14/cog3pio/pull/1))
+
+### 🧑‍🤝‍🧑 Contributors
+
+- [@weiji14](https://github.com/weiji14)

docs/changelog.md

@@ -7,13 +7,13 @@
 ### Rust
 
 ```bash
-cargo add --git https://github.com/weiji14/cog3pio.git
+cargo add cog3pio
 ```
 
 ### Python
 
 ```bash
-pip install git+https://github.com/weiji14/cog3pio.git
+pip install cog3pio
 ```
 
 > [!TIP]

docs/index.md

@@ -18,7 +18,7 @@ Notes:
 
 ## PyCapsule (DLPack)
 
-Read a GeoTIFF file from a HTTP url via the [CogReader](/api.html#dlpack) class into an
+Read a GeoTIFF file from a HTTP url via the [`CogReader`](api.html#dlpack) class into an
 object that conforms to the
 [Python Specification for DLPack](https://dmlc.github.io/dlpack/latest/python_spec.html),
 whereby the `__dlpack__()` method returns a
@@ -44,7 +44,7 @@ assert array.dtype == "float16"
 
 ## Xarray
 
-Read GeoTIFF file from a HTTP url via the [`Cog3pioBackendEntrypoint`](/api.html#xarray)
+Read GeoTIFF file from a HTTP url via the [`Cog3pioBackendEntrypoint`](api.html#xarray)
 engine into an `xarray.DataArray` object (akin to
 [`rioxarray`](https://corteva.github.io/rioxarray)).
 
@@ -62,7 +62,7 @@ assert dataarray.dtype == "uint16"
 
 ## NumPy
 
-Read a GeoTIFF file from a HTTP url via the [`read_geotiff`](/api.html#numpy) function
+Read a GeoTIFF file from a HTTP url via the [`read_geotiff`](api.html#numpy) function
 into a `numpy.ndarray` (akin to [`rasterio`](https://rasterio.readthedocs.io)).
 
 ```python

docs/quickstart.md

@@ -5,14 +5,20 @@ build-backend = "maturin"
 [project]
 name = "cog3pio"
 requires-python = ">=3.12"
+license = "MIT OR Apache-2.0"
+license-files = ["LICENSE-MIT", "LICENSE-APACHE"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Libraries",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
     "Programming Language :: Rust",
+    "Programming Language :: Python :: Free Threading",
     "Programming Language :: Python :: Implementation :: CPython",
-    "Programming Language :: Python :: Implementation :: PyPy",
-    "License :: OSI Approved :: Apache Software License",
-    "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
     "numpy>=2.0",

pyproject.toml

@@ -4,4 +4,4 @@
 
 
 def test_version():
-    assert Version(version=__version__) >= Version(version="0.0.0")
+    assert Version(version=__version__) >= Version(version="0.0.1")