diff --git a/.all-contributorsrc b/.all-contributorsrc index f88764f..41fd553 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,5 +1,5 @@ { - "projectName": "array-api", + "projectName": "types-array-api", "projectOwner": "34j", "repoType": "github", "repoHost": "https://github.com", diff --git a/.copier-answers.yml b/.copier-answers.yml index 0e9f254..ae33e2e 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,23 +1,20 @@ # Changes here will be overwritten by Copier _commit: 2e4f7d0 _src_path: gh:34j/pypackage-template -add_me_as_contributor: false cli_name: array-api copyright_year: '2025' documentation: true email: 34j.95a2p@simplelogin.com full_name: 34j -github_app_installation_ids: 31487150,37771054 github_username: 34j has_cli: true initial_commit: false is_django_package: false open_source_license: Apache Software License 2.0 -open_with_editor: true package_name: array_api project_name: Python array API standard typing project_short_description: Typing for array API and array-api-compat -project_slug: array-api +project_slug: types-array-api run_uv_sync: false setup_github: false setup_pre_commit: false diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml index f1aaedd..e225b59 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -45,7 +45,7 @@ body: attributes: label: Code of Conduct description: By submitting this issue, you agree to follow our - [Code of Conduct](https://github.com/34j/array-api/blob/main/.github/CODE_OF_CONDUCT.md). + [Code of Conduct](https://github.com/34j/types-array-api/blob/main/.github/CODE_OF_CONDUCT.md). options: - label: I agree to follow this project's Code of Conduct. required: true @@ -53,7 +53,7 @@ body: id: no-duplicate attributes: label: No Duplicate - description: Please check [existing issues](https://github.com/34j/array-api/issues) to avoid duplicates. + description: Please check [existing issues](https://github.com/34j/types-array-api/issues) to avoid duplicates. options: - label: I have checked existing issues to avoid duplicates. required: true diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml index 8cba57d..27f7e5f 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -29,7 +29,7 @@ body: attributes: label: Code of Conduct description: By submitting this issue, you agree to follow our - [Code of Conduct](https://github.com/34j/array-api/blob/main/.github/CODE_OF_CONDUCT.md). + [Code of Conduct](https://github.com/34j/types-array-api/blob/main/.github/CODE_OF_CONDUCT.md). options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ed4352e..71f7062 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,5 +4,5 @@ blank_issues_enabled: false contact_links: - name: Questions - url: https://github.com/34j/array-api/discussions/categories/q-a + url: https://github.com/34j/types-array-api/discussions/categories/q-a about: Please ask and answer questions here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e6456fd..4e67a71 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ - [ ] Code is up-to-date with the `main` branch -- [ ] This pull request follows the [contributing guidelines](https://github.com/34j/array-api/blob/main/CONTRIBUTING.md). +- [ ] This pull request follows the [contributing guidelines](https://github.com/34j/types-array-api/blob/main/CONTRIBUTING.md). - [ ] This pull request links relevant issues as `Fixes #0000` - [ ] There are new or updated unit tests validating the change - [ ] Documentation has been updated to reflect this change diff --git a/CHANGELOG.md b/CHANGELOG.md index 1aa21e5..533c9c7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,12 +4,12 @@ ### Documentation -- Add screenshot ([`809ab74`](https://github.com/34j/array-api/commit/809ab74ce3805404100cd4248cc5d42787b35017)) +- Add screenshot ([`809ab74`](https://github.com/34j/types-array-api/commit/809ab74ce3805404100cd4248cc5d42787b35017)) ## v0.1.0 (2025-06-07) ### Features -- Add main feat ([`3604571`](https://github.com/34j/array-api/commit/3604571a3be95353ef3c4a5354545ca711d91cfb)) +- Add main feat ([`3604571`](https://github.com/34j/types-array-api/commit/3604571a3be95353ef3c4a5354545ca711d91cfb)) ## v0.0.0 (2025-06-07) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1993c7a..c7359b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ Ready to contribute? Here's how to set yourself up for local development. 2. Clone your fork locally: ```shell - $ git clone git@github.com:your_name_here/array-api.git + $ git clone git@github.com:your_name_here/types-array-api.git ``` 3. Install the project dependencies with [uv](https://docs.astral.sh/uv/): @@ -114,4 +114,4 @@ $ pytest tests The deployment should be automated and can be triggered from the Semantic Release workflow in GitHub. The next version will be based on [the commit logs](https://python-semantic-release.readthedocs.io/en/latest/commit-log-parsing.html#commit-log-parsing). This is done by [python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/index.html) via a GitHub action. -[gh-issues]: https://github.com/34j/array-api/issues +[gh-issues]: https://github.com/34j/types-array-api/issues diff --git a/README.md b/README.md index bec4941..1bd62e9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Python array API standard typing

- + CI Status @@ -34,7 +34,7 @@ **Documentation**: https://array-api.readthedocs.io -**Source Code**: https://github.com/34j/array-api +**Source Code**: https://github.com/34j/types-array-api --- @@ -45,7 +45,7 @@ Typing for array API and array-api-compat Install this via pip (or your favourite package manager): ```shell -pip install array-api +pip install types-array-api ``` ## Usage diff --git a/docs/installation.md b/docs/installation.md index 199ff05..6fa19f0 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,10 +2,10 @@ # Installation -The package is published on [PyPI](https://pypi.org/project/array-api/) and can be installed with `pip` (or any equivalent): +The package is published on [PyPI](https://pypi.org/project/types-array-api/) and can be installed with `pip` (or any equivalent): ```bash -pip install array-api +pip install types-array-api ``` Next, see the {ref}`section about usage ` to see how to use it. diff --git a/pyproject.toml b/pyproject.toml index 906225c..9137337 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ build-backend = "setuptools.build_meta" requires = [ "setuptools" ] [project] -name = "array-api" +name = "types-array-api" version = "1.0.0" description = "Typing for array API and array-api-compat" readme = "README.md" @@ -30,10 +30,10 @@ dependencies = [ "rich>=10", "typer>=0.15,<1", ] -urls."Bug Tracker" = "https://github.com/34j/array-api/issues" -urls.Changelog = "https://github.com/34j/array-api/blob/main/CHANGELOG.md" +urls."Bug Tracker" = "https://github.com/34j/types-array-api/issues" +urls.Changelog = "https://github.com/34j/types-array-api/blob/main/CHANGELOG.md" urls.documentation = "https://array-api.readthedocs.io" -urls.repository = "https://github.com/34j/array-api" +urls.repository = "https://github.com/34j/types-array-api" scripts.array-api = "array_api.cli:app" [dependency-groups] diff --git a/src/array_api/main.py b/src/array_api/main.py deleted file mode 100644 index 8400ef8..0000000 --- a/src/array_api/main.py +++ /dev/null @@ -1,3 +0,0 @@ -def add(n1: int, n2: int) -> int: - """Add the arguments.""" - return n1 + n2 diff --git a/uv.lock b/uv.lock index 90d89ed..ff3331b 100644 --- a/uv.lock +++ b/uv.lock @@ -30,54 +30,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/a1/ee/48ca1a7c89ffec8b6a0c5d02b89c305671d5ffd8d3c94acf8b8c408575bb/anyio-4.9.0-py3-none-any.whl", hash = "sha256:9f76d541cad6e36af7beb62e978876f3b41e3e04f2c1fbf0884604c0a9c4d93c", size = 100916, upload-time = "2025-03-17T00:02:52.713Z" }, ] -[[package]] -name = "array-api" -version = "1.0.0" -source = { editable = "." } -dependencies = [ - { name = "attrs" }, - { name = "rich" }, - { name = "typer" }, -] - -[package.dev-dependencies] -dev = [ - { name = "array-api-compat", version = "1.11.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, - { name = "array-api-compat", version = "1.12.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" }, - { name = "array-api-strict" }, - { name = "pytest" }, - { name = "pytest-cov" }, - { name = "ruff" }, -] -docs = [ - { name = "furo", marker = "python_full_version >= '3.11'" }, - { name = "myst-parser", marker = "python_full_version >= '3.11'" }, - { name = "sphinx", marker = "python_full_version >= '3.11'" }, - { name = "sphinx-autobuild", marker = "python_full_version >= '3.11'" }, -] - -[package.metadata] -requires-dist = [ - { name = "attrs", specifier = ">=25.3.0" }, - { name = "rich", specifier = ">=10" }, - { name = "typer", specifier = ">=0.15,<1" }, -] - -[package.metadata.requires-dev] -dev = [ - { name = "array-api-compat", specifier = ">=1.11.2" }, - { name = "array-api-strict", specifier = ">=2.3.1" }, - { name = "pytest", specifier = ">=8,<9" }, - { name = "pytest-cov", specifier = ">=6,<7" }, - { name = "ruff", specifier = ">=0.11.13" }, -] -docs = [ - { name = "furo", marker = "python_full_version >= '3.11'", specifier = ">=2023.5.20" }, - { name = "myst-parser", marker = "python_full_version >= '3.11'", specifier = ">=0.16" }, - { name = "sphinx", marker = "python_full_version >= '3.11'", specifier = ">=4" }, - { name = "sphinx-autobuild", marker = "python_full_version >= '3.11'", specifier = ">=2024,<2025" }, -] - [[package]] name = "array-api-compat" version = "1.11.2" @@ -1060,6 +1012,54 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/76/42/3efaf858001d2c2913de7f354563e3a3a2f0decae3efe98427125a8f441e/typer-0.16.0-py3-none-any.whl", hash = "sha256:1f79bed11d4d02d4310e3c1b7ba594183bcedb0ac73b27a9e5f28f6fb5b98855", size = 46317, upload-time = "2025-05-26T14:30:30.523Z" }, ] +[[package]] +name = "types-array-api" +version = "1.0.0" +source = { editable = "." } +dependencies = [ + { name = "attrs" }, + { name = "rich" }, + { name = "typer" }, +] + +[package.dev-dependencies] +dev = [ + { name = "array-api-compat", version = "1.11.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" }, + { name = "array-api-compat", version = "1.12.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" }, + { name = "array-api-strict" }, + { name = "pytest" }, + { name = "pytest-cov" }, + { name = "ruff" }, +] +docs = [ + { name = "furo", marker = "python_full_version >= '3.11'" }, + { name = "myst-parser", marker = "python_full_version >= '3.11'" }, + { name = "sphinx", marker = "python_full_version >= '3.11'" }, + { name = "sphinx-autobuild", marker = "python_full_version >= '3.11'" }, +] + +[package.metadata] +requires-dist = [ + { name = "attrs", specifier = ">=25.3.0" }, + { name = "rich", specifier = ">=10" }, + { name = "typer", specifier = ">=0.15,<1" }, +] + +[package.metadata.requires-dev] +dev = [ + { name = "array-api-compat", specifier = ">=1.11.2" }, + { name = "array-api-strict", specifier = ">=2.3.1" }, + { name = "pytest", specifier = ">=8,<9" }, + { name = "pytest-cov", specifier = ">=6,<7" }, + { name = "ruff", specifier = ">=0.11.13" }, +] +docs = [ + { name = "furo", marker = "python_full_version >= '3.11'", specifier = ">=2023.5.20" }, + { name = "myst-parser", marker = "python_full_version >= '3.11'", specifier = ">=0.16" }, + { name = "sphinx", marker = "python_full_version >= '3.11'", specifier = ">=4" }, + { name = "sphinx-autobuild", marker = "python_full_version >= '3.11'", specifier = ">=2024,<2025" }, +] + [[package]] name = "typing-extensions" version = "4.14.0"