feat: add main feat (#1)

Author: 34j

.github/workflows/ci.yml

@@ -36,9 +36,9 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
-          - "3.10"
-          - "3.11"
+          # - "3.9"
+          # - "3.10"
+          # - "3.11"
           - "3.12"
           - "3.13"
         os:

.pre-commit-config.yaml

@@ -13,6 +13,16 @@ repos:
     hooks:
       - id: commitizen
         stages: [commit-msg]
+  # run .pre-commit/update_array_namespace.py
+  # - repo: local
+  #   hooks:
+  #     - id: update-array-namespace
+  #       name: Update array namespace
+  #       entry: python -m src.array_api
+  #       language: python
+  #       additional_dependencies: ["attrs", "typer", "ssort", "ruff"]
+  #       require_serial: true
+  #       pass_filenames: false
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
@@ -44,14 +54,14 @@ repos:
     rev: v0.11.5
     hooks:
       - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+        args: [--fix, --unsafe-fixes, --exit-non-zero-on-fix]
       - id: ruff-format
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.1
-    hooks:
-      - id: codespell
+  # - repo: https://github.com/codespell-project/codespell
+  #   rev: v2.4.1
+  #   hooks:
+  #     - id: codespell
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.15.0
     hooks:
       - id: mypy
-        additional_dependencies: []
+        additional_dependencies: [attrs]

LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2025 Consortium for Python Data API Standards contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -44,7 +44,47 @@ Typing for array API and array-api-compat
 
 Install this via pip (or your favourite package manager):
 
-`pip install array-api`
+```shell
+pip install array-api
+```
+
+## Usage
+
+### Type stubs
+
+Provices type stubs for [`array-api-compat`](https://data-apis.org/array-api-compat/).
+
+```python
+import array_api_compat
+
+xp = array_api_compat.array_namespace(x)
+```
+
+### Array Type
+
+```python
+from array_api._2024_12 import Array
+
+
+def my_function[TArray: Array](x: TArray) -> TArray:
+    return x + 1
+```
+
+### Namespace Type
+
+You can test if an object matches the Protocol by:
+
+```python
+import array_api_strict
+
+from array_api._2024_12 import ArrayNamespace, ArrayNamespaceFull
+
+
+assert isinstance(array_api_strict, ArrayNamespace)
+# Full version contains fft and linalg
+# fft and linalg are not included by default in array_api_strict
+assert not isinstance(array_api_strict, ArrayNamespaceFull)
+```
 
 ## Contributors ✨
 

pyproject.toml

@@ -7,7 +7,7 @@ name = "array-api"
 version = "0.0.0"
 description = "Typing for array API and array-api-compat"
 readme = "README.md"
-license = { text = "Apache Software License 2.0" }
+license = "MIT AND Apache-2.0"
 authors = [
   { name = "34j", email = "[email protected]" },
 ]
@@ -26,6 +26,7 @@ classifiers = [
 ]
 
 dependencies = [
+  "attrs>=25.3.0",
   "rich>=10",
   "typer>=0.15,<1",
 ]
@@ -37,8 +38,11 @@ scripts.array-api = "array_api.cli:app"
 
 [dependency-groups]
 dev = [
+  "array-api-compat>=1.11.2",
+  "array-api-strict>=2.3.1",
   "pytest>=8,<9",
   "pytest-cov>=6,<7",
+  "ruff>=0.11.13",
 ]
 docs = [
   "furo>=2023.5.20; python_version>='3.11'",
@@ -48,7 +52,7 @@ docs = [
 ]
 
 [tool.ruff]
-line-length = 88
+line-length = 320
 lint.select = [
   "B",   # flake8-bugbear
   "D",   # flake8-docstrings
@@ -68,6 +72,9 @@ lint.ignore = [
   "D104", # Missing docstring in public package
   "D107", # Missing docstring in `__init__`
   "D401", # First line of docstring should be in imperative mood
+  "S603",
+  "S607",
+  "E501"
 ]
 lint.per-file-ignores."conftest.py" = [ "D100" ]
 lint.per-file-ignores."docs/conf.py" = [ "D100" ]
@@ -106,7 +113,7 @@ exclude_lines = [
 
 [tool.mypy]
 check_untyped_defs = true
-disallow_any_generics = true
+disallow_any_generics = false
 disallow_incomplete_defs = true
 disallow_untyped_defs = true
 mypy_path = "src/"