Skip to content

Commit eaf0e61

Browse files
fix: publish canonical package metadata (#17)
1 parent be310ff commit eaf0e61

3 files changed

Lines changed: 63 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![PyPI](https://img.shields.io/pypi/v/ml4t-specs)](https://pypi.org/project/ml4t-specs/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66

7-
Shared schema and artifact contracts for the ML4T library ecosystem.
7+
Serializable, runtime-neutral contracts for market data, artifacts, strategy lifecycles, and
8+
execution across the ML4T library ecosystem.
89

910
The stable support matrix is CPython 3.12 through 3.14 on Linux, macOS, and Windows.
1011
CPython 3.15 prereleases are tested on all three operating systems but are not advertised as

‎pyproject.toml‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,28 @@ include = [
2020
[project]
2121
name = "ml4t-specs"
2222
dynamic = ["version"]
23-
description = "Shared artifact and schema specifications for ML4T libraries"
23+
description = "Serializable, runtime-neutral contracts for market data, artifacts, strategy lifecycles, and execution across ML4T libraries."
2424
readme = "README.md"
25-
license = { text = "MIT" }
25+
license = "MIT"
26+
license-files = ["LICENSE"]
27+
authors = [
28+
{ name = "Stefan Jansen", email = "[email protected]" },
29+
]
30+
maintainers = [
31+
{ name = "Stefan Jansen", email = "[email protected]" },
32+
]
33+
keywords = [
34+
"finance",
35+
"quantitative-finance",
36+
"algorithmic-trading",
37+
"trading",
38+
"market-data",
39+
"schemas",
40+
"data-contracts",
41+
"serialization",
42+
"backtesting",
43+
"live-trading",
44+
]
2645
requires-python = ">=3.12"
2746
dependencies = [
2847
"pyyaml>=6.0",
@@ -45,7 +64,7 @@ classifiers = [
4564
]
4665

4766
[project.urls]
48-
Homepage = "https://github.com/ml4t/specs"
67+
Homepage = "https://www.ml4trading.io/"
4968
Documentation = "https://www.ml4trading.io/docs/specs/"
5069
Repository = "https://github.com/ml4t/specs"
5170
Issues = "https://github.com/ml4t/specs/issues"
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
"""Contracts for the public distribution metadata."""
2+
3+
from __future__ import annotations
4+
5+
import tomllib
6+
from pathlib import Path
7+
8+
9+
def test_distribution_metadata_matches_public_identity() -> None:
10+
root = Path(__file__).parents[1]
11+
project = tomllib.loads((root / "pyproject.toml").read_text(encoding="utf-8"))["project"]
12+
13+
assert project["description"] == (
14+
"Serializable, runtime-neutral contracts for market data, artifacts, strategy "
15+
"lifecycles, and execution across ML4T libraries."
16+
)
17+
assert project["authors"] == [{"name": "Stefan Jansen", "email": "[email protected]"}]
18+
assert project["maintainers"] == [{"name": "Stefan Jansen", "email": "[email protected]"}]
19+
assert set(project["keywords"]) == {
20+
"finance",
21+
"quantitative-finance",
22+
"algorithmic-trading",
23+
"trading",
24+
"market-data",
25+
"schemas",
26+
"data-contracts",
27+
"serialization",
28+
"backtesting",
29+
"live-trading",
30+
}
31+
assert project["license"] == "MIT"
32+
assert project["license-files"] == ["LICENSE"]
33+
assert project["urls"] == {
34+
"Homepage": "https://www.ml4trading.io/",
35+
"Documentation": "https://www.ml4trading.io/docs/specs/",
36+
"Repository": "https://github.com/ml4t/specs",
37+
"Issues": "https://github.com/ml4t/specs/issues",
38+
"Changelog": "https://github.com/ml4t/specs/releases",
39+
}

0 commit comments

Comments
 (0)