Update licence string (#2)

Quantco · Jun 15, 2024 · eb2dac9 · eb2dac9
1 parent 57bb349
commit eb2dac9
Show file tree

Hide file tree

Showing 44 changed files with 77 additions and 121 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,7 +17,7 @@ repos:
         entry: >-
           pixi run -e lint
           insert-license
-          --license-base64 Q29weXJpZ2h0IChjKSBRdWFudENvIHt5ZWFyX3N0YXJ0fS17eWVhcl9lbmR9ClNQRFgtTGljZW5zZS1JZGVudGlmaWVyOiBMaWNlbnNlUmVmLVF1YW50Q28K
+          --license-base64 Q29weXJpZ2h0IChjKSBRdWFudENvIDIwMjMtMjAyNApTUERYLUxpY2Vuc2UtSWRlbnRpZmllcjogQlNELTMtQ2xhdXNlCg==
           --dynamic-years
           --comment-style "#"
         language: system

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,12 @@
+version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3"
+  commands:
+    - curl -fsSL https://pixi.sh/install.sh | bash
+    - chmod +x ~/.pixi/bin/pixi
+    - ~/.pixi/bin/pixi run -e docs postinstall
+    - ~/.pixi/bin/pixi run -e docs docs
+    - mkdir -p $READTHEDOCS_OUTPUT/html/
+    - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # ndonnx
 
 [![CI](https://img.shields.io/github/actions/workflow/status/quantco/ndonnx/ci.yml?style=flat-square&branch=main)](https://github.com/quantco/ndonnx/actions/workflows/ci.yml)
-[![Documentation](https://img.shields.io/github/actions/workflow/status/quantco/ndonnx/docs.yml?style=flat-square&branch=main)](https://quantco.github.io/ndonnx)
+[![Documentation]](https://ndonnx.readthedocs.io/)
 [![conda-forge](https://img.shields.io/conda/pn/conda-forge/ndonnx?style=flat-square&logoColor=white&logo=conda-forge)](https://prefix.dev/channels/conda-forge/packages/ndonnx)
 
 An ONNX-backed array library that is compliant with the [Array API](https://data-apis.org/array-api/) standard.

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2022-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 # Configuration file for the Sphinx documentation builder.
 #

diff --git a/docs/experimental/experimental.rst b/docs/experimental/experimental.rst
@@ -60,7 +60,6 @@ Internally, ``ndonnx`` defines the ``StructType`` interface. This interface is u
 The interface is defined below:
 
 .. autoclass:: ndonnx._experimental.StructType
-   :no-index:
    :members:
    :undoc-members:
    :private-members:

diff --git a/ndonnx/__init__.py b/ndonnx/__init__.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2022-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 import importlib.metadata
 import warnings

diff --git a/ndonnx/_array.py b/ndonnx/_array.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_build.py b/ndonnx/_build.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_constants.py b/ndonnx/_constants.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 

diff --git a/ndonnx/_core/__init__.py b/ndonnx/_core/__init__.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from ._impl import CoreOperationsImpl
 from ._interface import OperationsBlock

diff --git a/ndonnx/_core/_impl.py b/ndonnx/_core/_impl.py
@@ -1,5 +1,6 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 import functools

diff --git a/ndonnx/_core/_interface.py b/ndonnx/_core/_interface.py
@@ -1,5 +1,6 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 from typing import Literal

diff --git a/ndonnx/_corearray.py b/ndonnx/_corearray.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_data_types/__init__.py b/ndonnx/_data_types/__init__.py
@@ -1,5 +1,6 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 from .aliases import (

diff --git a/ndonnx/_data_types/aliases.py b/ndonnx/_data_types/aliases.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from .classes import (
     Boolean,

diff --git a/ndonnx/_data_types/classes.py b/ndonnx/_data_types/classes.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_data_types/conversion.py b/ndonnx/_data_types/conversion.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_data_types/coretype.py b/ndonnx/_data_types/coretype.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_data_types/schema.py b/ndonnx/_data_types/schema.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from dataclasses import dataclass
 

diff --git a/ndonnx/_data_types/structtype.py b/ndonnx/_data_types/structtype.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_experimental.py b/ndonnx/_experimental.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from ._core import OperationsBlock
 from ._data_types import CastMixin, Schema, StructType

diff --git a/ndonnx/_funcs.py b/ndonnx/_funcs.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_index.py b/ndonnx/_index.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from collections.abc import Iterable
 from typing import TypeVar, Union

diff --git a/ndonnx/_opset_extensions.py b/ndonnx/_opset_extensions.py
@@ -1,5 +1,6 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 import builtins

diff --git a/ndonnx/_propagation.py b/ndonnx/_propagation.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/_utility.py b/ndonnx/_utility.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/ndonnx/additional/__init__.py b/ndonnx/additional/__init__.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from ._additional import fill_null, make_nullable, isin, shape, static_map
 

diff --git a/ndonnx/additional/_additional.py b/ndonnx/additional/_additional.py
@@ -1,5 +1,6 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 from collections.abc import Mapping, Sequence

diff --git a/pixi.toml b/pixi.toml
@@ -11,6 +11,7 @@ postinstall = "pip install --no-build-isolation --no-deps --disable-pip-version-
 python = ">=3.10"
 numpy = "*"
 spox = ">=0.10"
+typing_extensions = "*"
 
 [host-dependencies]
 pip = "*"

diff --git a/pyproject.toml b/pyproject.toml
@@ -14,12 +14,20 @@ authors = [
     { name = "Christian Bourjau", email = "[email protected]" },
 ]
 classifiers = [
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
 requires-python = ">=3.10"
+dependencies = ["numpy", "spox>=0.10", "typing_extensions"]
+keywords = [
+  "numpy",
+  "onnx",
+  "array-api",
+]
 
 [project.urls]
 repository = "https://github.com/quantco/ndonnx"

diff --git a/scripts/create_typing.sh b/scripts/create_typing.sh
diff --git a/scripts/parse_test_report.py b/scripts/parse_test_report.py
diff --git a/scripts/test.sh b/scripts/test.sh
diff --git a/tests/ndonnx/test_additional.py b/tests/ndonnx/test_additional.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 import sys
 

diff --git a/tests/ndonnx/test_build_utils.py b/tests/ndonnx/test_build_utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 import pytest
 

diff --git a/tests/ndonnx/test_compute_modes.py b/tests/ndonnx/test_compute_modes.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 import numpy as np
 import numpy.array_api as npx

diff --git a/tests/ndonnx/test_constant_propagation.py b/tests/ndonnx/test_constant_propagation.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from typing import Literal
 

diff --git a/tests/ndonnx/test_core.py b/tests/ndonnx/test_core.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations
 

diff --git a/tests/ndonnx/test_dtypes.py b/tests/ndonnx/test_dtypes.py
@@ -1,5 +1,6 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
+
 from __future__ import annotations
 
 import re

diff --git a/tests/ndonnx/test_include.py b/tests/ndonnx/test_include.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 
 def test_import():

diff --git a/tests/ndonnx/test_masked.py b/tests/ndonnx/test_masked.py
@@ -1,5 +1,5 @@
 # Copyright (c) QuantCo 2023-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# SPDX-License-Identifier: BSD-3-Clause
 
 import math
 

diff --git a/tests/ndonnx/utils.py b/tests/ndonnx/utils.py
@@ -1,5 +1,5 @@
-# Copyright (c) QuantCo 2024-2024
-# SPDX-License-Identifier: LicenseRef-QuantCo
+# Copyright (c) QuantCo 2023-2024
+# SPDX-License-Identifier: BSD-3-Clause
 
 from __future__ import annotations