VER: Release 0.28.0

threecgreen · web-flow · commit ea2f2a598ece · 2025-02-11T17:31:59.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.28.0 - 2025-02-11
+
+### Breaking changes
+- Added `CommoditySpot` `InstrumentClass` variant and made `InstrumentClass`
+  non-exhaustive to allow future additions without breaking changes
+
 ## 0.27.0 - 2025-01-21
 
 ### Breaking changes
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,7 +11,7 @@ resolver = "2"
 [workspace.package]
 authors = ["Databento <support@databento.com>"]
 edition = "2021"
-version = "0.27.0"
+version = "0.28.0"
 documentation = "https://databento.com/docs"
 repository = "https://github.com/databento/dbn"
 license = "Apache-2.0"
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "databento-dbn"
-version = "0.27.0"
+version = "0.28.0"
 description = "Python bindings for encoding and decoding Databento Binary Encoding (DBN)"
 authors = ["Databento <support@databento.com>"]
 license = "Apache-2.0"
@@ -17,7 +17,7 @@ build-backend = "maturin"
 
 [project]
 name = "databento-dbn"
-version = "0.27.0"
+version = "0.28.0"
 authors = [
     { name = "Databento", email = "support@databento.com" }
 ]
diff --git a/python/python/databento_dbn/_lib.pyi b/python/python/databento_dbn/_lib.pyi
@@ -129,6 +129,8 @@ class InstrumentClass(Enum):
         A spread composed of options.
     FX_SPOT
         A foreign exchange spot.
+    COMMODITY_SPOT
+        A commodity being traded for immediate delivery.
 
     """
 
@@ -141,6 +143,7 @@ class InstrumentClass(Enum):
     FUTURE_SPREAD: str
     OPTION_SPREAD: str
     FX_SPOT: str
+    COMMODITY_SPOT: str
 
     @classmethod
     def from_str(cls, value: str) -> InstrumentClass: ...
diff --git a/rust/dbn-cli/Cargo.toml b/rust/dbn-cli/Cargo.toml
@@ -16,7 +16,7 @@ name = "dbn"
 path = "src/main.rs"
 
 [dependencies]
-dbn = { path = "../dbn", version = "=0.27.0", default-features = false }
+dbn = { path = "../dbn", version = "=0.28.0", default-features = false }
 
 anyhow = { workspace = true }
 clap = { version = "4.5", features = ["derive", "wrap_help"] }
diff --git a/rust/dbn-cli/README.md b/rust/dbn-cli/README.md
@@ -19,8 +19,7 @@ cargo install dbn-cli
 
 ## Usage
 
-`dbn` currently supports CSV and JSON (technically [newline-delimited JSON](http://ndjson.org/))
-as output formats.
+`dbn` currently supports CSV and [JSON lines](https://jsonlines.org/) as output formats.
 By default, `dbn` outputs the result to standard output for ease of use with
 text-based command-line utilities.
 Running
diff --git a/rust/dbn-cli/src/lib.rs b/rust/dbn-cli/src/lib.rs
@@ -53,7 +53,7 @@ pub struct Args {
         action = ArgAction::SetTrue,
         default_value = "false",
         group = "output_encoding",
-        help = "Output the result as NDJSON (newline-delimited JSON)"
+        help = "Output the result as JSON lines"
     )]
     pub json: bool,
     #[clap(
diff --git a/rust/dbn/Cargo.toml b/rust/dbn/Cargo.toml
@@ -25,7 +25,7 @@ serde = ["dep:serde", "time/parsing", "time/serde"]
 trivial_copy = []
 
 [dependencies]
-dbn-macros = { version = "=0.27.0", path = "../dbn-macros" }
+dbn-macros = { version = "=0.28.0", path = "../dbn-macros" }
 
 async-compression = { version = "0.4.18", features = ["tokio", "zstd"], optional = true }
 csv = { workspace = true }
diff --git a/rust/dbn/src/encode/json.rs b/rust/dbn/src/encode/json.rs
@@ -1,4 +1,4 @@
-//! Encoding of DBN records into newline-delimited JSON (ndjson).
+//! Encoding of DBN records into [JSON lines](https://jsonlines.org).
 
 pub(crate) mod serialize;
 mod sync;
diff --git a/rust/dbn/src/encode/json/async.rs b/rust/dbn/src/encode/json/async.rs
@@ -6,7 +6,7 @@ use crate::{
     Metadata, Result,
 };
 
-/// Type for encoding files and streams of DBN records in newline-delimited JSON (ndjson).
+/// Type for encoding files and streams of DBN records in JSON lines.
 pub struct Encoder<W>
 where
     W: io::AsyncWriteExt + Unpin,
diff --git a/rust/dbn/src/encode/json/sync.rs b/rust/dbn/src/encode/json/sync.rs
@@ -6,7 +6,7 @@ use crate::{
     rtype_method_dispatch, rtype_ts_out_method_dispatch, Error, Metadata, Result,
 };
 
-/// Type for encoding files and streams of DBN records in newline-delimited JSON (ndjson).
+/// Type for encoding files and streams of DBN records in JSON lines.
 pub struct Encoder<W>
 where
     W: io::Write,
diff --git a/rust/dbn/src/enums.rs b/rust/dbn/src/enums.rs
@@ -82,6 +82,7 @@ impl From<Action> for char {
     derive(strum::EnumIter),
     pyo3::pyclass(module = "databento_dbn", rename_all = "SCREAMING_SNAKE_CASE")
 )]
+#[non_exhaustive]
 #[repr(u8)]
 pub enum InstrumentClass {
     /// A bond.
@@ -102,6 +103,8 @@ pub enum InstrumentClass {
     OptionSpread = b'T',
     /// A foreign exchange spot.
     FxSpot = b'X',
+    /// A commodity being traded for immediate delivery.
+    CommoditySpot = b'Y',
 }
 
 impl From<InstrumentClass> for char {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//! Encoding of DBN records into newline-delimited JSON (ndjson).`
	`1`	`+//! Encoding of DBN records into [JSON lines](https://jsonlines.org).`
`2`	`2`
`3`	`3`	`pub(crate) mod serialize;`
`4`	`4`	`mod sync;`