chore: apply Copier template #14

34j · 2025-06-04T11:20:54Z

I think this is good for now. @jorenham @nstarman

For now, I just applied the template, so major changes can be made later. Some necessary manual changes are made after 5405a8c. See https://github.com/34j/jordan-form for the result. The documentation is hosted at https://jordan-form.readthedocs.io/en/latest/.
The CLI is optional for end users and will be used for automatic code generation.
Maintainers need to configure the following settings as described here: https://github.com/browniebroke/pypackage-template#secrets and automated here https://github.com/34j/pypackage-template/blob/2e4f7d01d2fa20277467c6b5046f081b84f834d2/copier.yml#L142-L152
- Set GH_PAT (repo scope, for label management etc.) and CODECOV_TOKEN in secret variables
- Install GitHub Apps Renovate (for Python and Typer version management in our case, maybe typing_extensions is needed as well) and pre-commit.ci
- Set workflow permissions to Read and Write
Additionally:
- Setup Trusted publisher on PyPI (ci.yml and release) so that we can already do package name parking after this PR is merged
- Setup Read The Docs (just push + button on readthedocs.org)

34j · 2025-06-05T01:12:49Z

I wonder why CI is not running

34j · 2025-06-05T12:05:21Z

Unless I can confirm that maintainers agree with most of this PR, I will not be able to open another PR for implementation. Do you have any comments? I suppose @nstarman would have the most opinions about this. When do you think you will be able to review it by? Sorry for the impatience.

In case the setup is a hassle, I can do most of it as long as you authorize me to do it. (I've been denied many times though.)

nstarman · 2025-06-05T13:02:28Z

Review in progress. There are a lot of files.

nstarman

Thanks @34j for the PR! Overall it's good and the forward momentum is appreciated.
A number of comments about tailoring this PR to this repo.

.codespellrc

nstarman · 2025-06-04T12:21:16Z

pyproject.toml

+build-backend = "setuptools.build_meta"
+requires = [ "setuptools" ]


I think we'd prefer to keep hatch as the build system.

nstarman · 2025-06-04T12:22:17Z

pyproject.toml

-    Repository = "https://github.com/data-apis/array-api-typing"
-    Changelog = "https://github.com/data-apis/array-api-typing/releases"
-
-
 [build-system]


The ordering changed. Can you please change it back.

The order was changed by pyproject-fmt on its own. It is not my fault. 😉

SGTM. Then for ease of review, can you separate that into two commits (pre and post application of pre-commit)? I'm just scrolling up scrolling down repeatedly to try and make sure that the settings that were discussed and set up in prior PRs are preserved.

nstarman · 2025-06-04T12:24:01Z

tests/test_cli.py

nstarman · 2025-06-04T12:24:26Z

src/array_api_typing/cli.py

Same and we need cli for automatic code generation.

Could you elaborate on the code generation?

pyproject.toml

nstarman · 2025-06-05T15:25:19Z

pyproject.toml

+module = "docs.*"
+ignore_errors = true
+
+[tool.semantic_release]


Hm. I prefer vcs-based version tagging. We had set up hatch-vcs for this reason.
docs/conf.py can read the version out from the toml.

nstarman · 2025-06-05T15:27:31Z

src/array_api_typing/__init__.py

rm. VCS handles this.

nstarman · 2025-06-05T15:27:49Z

src/array_api_typing/main.py

If you delete these temp files, CI will fail and you will not know if this template works correctly.

Of course we are going to replace them in the next PR.

A simple __init__.py should suffice

I guess the coverage report would fail

Those files don't exist yet on main and coverage is computed relative to main.

I don't think that makes sense. Please do not try to waste my time. Or you may commit by yourself.

jorenham

I think we should leave out the docs for now. It's a big project on its own, with an enormous number of degrees of freedom. We should first decide whether we even want docs, and if we do, mkdocs will probably be more in line with all of the other array-api docs (plus I'm biased, because I can't sphinx haha).

34j · 2025-06-06T00:24:12Z

As a contributor to the Copier template, I am very scared to make any major changes to the template because I'm not sure it will work. And please note that copier upgrade will be more difficult.

I think documentation is primarily needed for the “API Reference”. The template utilized sphinx-apidoc etc. to automatically generate API.

34j · 2025-06-06T00:44:10Z

@nstarman I have no idea how Hatch works and have never used it, can you compromise with current Semantic-Release? All releases are automatic, so there should be no need to do anything manually. All versions will be replaced and updated automatically by Semantic-release bot.

nstarman · 2025-06-06T00:45:36Z

How does semantic release handle backports? Does it require supporting setup.py and setuptools? What about auto-incrementing per-commit during editable dev installs, which is important for testing CD on TestPyPI?
I'd be open if all those worked seamlessly, like they do with hatch or other setuptools replacements that support VCS.

34j · 2025-06-06T00:58:10Z

I don't think backports are needed for such a small package.

auto-incrementing per-commit during editable dev installs

I didn't understand this difficult word ...... what does it mean?

At leaset dry-run of Semantic-Release will confirm on PR that most parts of release workflow work fine. That should work on this PR as well... Have you disabled CI?

34j · 2025-06-06T01:20:43Z

I think I could have handled about half of the change requests. How about a compromise on this? Perhaps both your method and this template's method are wonderful and well automated, just the principle is slightly different

Thanks for your swift review anyway

34j · 2025-06-06T04:14:30Z

Don't spend time on things that are not essential... So as I said, one-sided censorship is taking place. I don't have infinite time.

jorenham · 2025-06-06T04:16:04Z

Don't spend time on things that are not essential... So as I said, one-sided censorship is taking place. I don't have infinite time.

Why are you saying that?

34j · 2025-06-06T04:16:58Z

No one is interested in the formatter or build system applied to the project. The types are needed.

jorenham · 2025-06-06T04:23:34Z

No one is interested in the formatter or build system applied to the project.

Development workflow is very important for efficient development. So consider this a necessary investment.

But what did you mean when you said

So as I said, one-sided censorship is taking place. I don't have infinite time.

...?

34j · 2025-06-06T04:28:07Z

I apologize if I have offended you, but I would like to point out that any further change requests would depend on personal taste rather than being essential, and would destroy all the advantages of the Copier template. Sorry if my English is not good.

nstarman · 2025-06-06T13:25:33Z

Have you disabled CI?

No.

any further change requests would depend on personal taste rather than being essential

This copier template is also entirely based on personal taste. And much of it is not essential.

destroy all the advantages of the Copier template.

I do think that's the crux of the issue. I'm not convinced this template provides all that good a starting point for this type of project. There are a million different copier templates which I've tried and found them useful for different purposes and almost universally only useful as a starting point not to be closely tied to forever. Here, the use of setuptools, ten different config files for systems we aren't using, dunder files including for CLI (why do we need that), etc. So I think the pushback isn't because we are censoring progress, but because we are trying to ensure it's progress and not bloat.

The easiest PR to merge would be a minimal one, which this large template is not. I think it's fair to expect a PR to be reviewed. There's 2 ways to make that process take longer. 1) to be doing something impactful that requires a thoughtful review, and 2) to have a large PR. This PR does both.

Half my comments are about removing unnecessary files. That would certainly make the Pr smaller, but there's still important considerations like how the package is installed and built, which is worthy of discussion.

I appreciate the forward momentum on this project. Let's systematically address the issues through the standard review process and get this merged in. I doubt we will maintain the ability to do copier update, but that's fine because if we build this right, then it will be very easy to maintain.

nstarman · 2025-06-06T14:13:08Z

I didn't understand this difficult word ...... what does it mean?

When the project is installed from a specific commit (eg in editable mode or during CI/CD) the version is unique and greater than the last release. For TestPyPI this is necessary to ensure that TestPyPI recognizes it as a new version.

34j · 2025-06-07T03:47:38Z

@nstarman Yes, I understand what you are saying, but you are being too particular. I don't care about the details the setup.

If I were in your shoes, I would want to complain massively about my PR, and I agree with you 100%:

My reference point is this Copier template. Unlike you (?), my 30+ packages are totally dependent on this template. The more I delete files generated by the template, the more anxious I get.
Your reference point is nothing, blank state. You are anxious about the large number of unnecessary settings.

So I think the problem is that the data-apis community is only collegial, you are the maintainer, and you also happen to have not much time to do the setup 🤔, you are still willing to be a "maintainer" (what are you maintaining ?🤔), and the members did not allow to “replace” me as the maintainer. (I seem to be somewhat not included in "we".)
If you were maintaining your own Copier template, you would apply it here and the setup would be instantly done.

Anyway, I'm not an expert in setup and I don't really know what changes you would like to make, so I would like to leave the rest to you 😴. Especially I have never used hatch. Thanks for your swift response.

34j · 2025-06-08T00:35:43Z

The work was completed at https://github.com/34j/array-api instead. Closing this with a demonstration of the maintainers' willingness not to take over this PR.

nstarman · 2025-06-08T00:51:07Z

Closing this with a demonstration of the maintainers' willingness not to take over this PR.

Wrong message received.
Very much happy to have automatic code generation and other nice well-thought out features.
Trying to engage in the standard PR review process to not have extraneous and/or outdated configurations.

nstarman · 2025-06-08T01:04:09Z

@34j We'd be very happy to take a PR adding in the very-useful automatic code generation, although your work in https://github.com/34j/array-api/tree/main/src/array_api_compat might be best done as an official array-api-compat-stubs package! Something to consider.

feat: apply Copier template

5405a8c

34j marked this pull request as draft June 4, 2025 11:21

34j added 3 commits June 4, 2025 20:42

fix: replace code of conduct

8e20e30

fix: update authors

2ca6e0e

chore(pre-commit): update hooks

9e2de01

34j force-pushed the feat/setup branch from bb05cf2 to 9e2de01 Compare June 4, 2025 12:04

34j added 2 commits June 4, 2025 21:07

fix: make cli optional

b11b717

style: pyproject-fmt somewhat not working

99cd14e

34j marked this pull request as ready for review June 4, 2025 12:11

34j changed the title ~~feat: apply Copier template~~ chore: apply Copier template Jun 4, 2025

jorenham requested review from jorenham and nstarman June 4, 2025 15:28

nstarman reviewed Jun 5, 2025

View reviewed changes

jorenham reviewed Jun 5, 2025

View reviewed changes

34j added 2 commits June 6, 2025 09:26

chore: remove .codespellrc

1a35cfc

chore: remove .gitpod.yml

d349fa2

34j added 3 commits June 6, 2025 10:00

chore: remove .editorconfig

12d31ad

chore: roll back pytest configuration

ffc0704

chore(ruff): use extend-*

be26a77

34j marked this pull request as draft June 7, 2025 03:51

34j closed this Jun 8, 2025

nstarman mentioned this pull request Jun 8, 2025

Rename package 34j/array-api#6

Open

5 tasks

		build-backend = "setuptools.build_meta"
		requires = [ "setuptools" ]

chore: apply Copier template #14

chore: apply Copier template #14

Uh oh!

Conversation

34j commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

34j commented Jun 5, 2025

Uh oh!

34j commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nstarman commented Jun 5, 2025

Uh oh!

nstarman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

34j Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

34j Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorenham left a comment

Choose a reason for hiding this comment

Uh oh!

34j commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

34j commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nstarman commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

34j commented Jun 6, 2025

Uh oh!

34j commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

34j commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

34j commented Jun 4, 2025 •

edited

Loading

34j commented Jun 5, 2025 •

edited

Loading

34j Jun 6, 2025 •

edited

Loading

34j Jun 6, 2025 •

edited

Loading

34j commented Jun 6, 2025 •

edited

Loading

34j commented Jun 6, 2025 •

edited

Loading

nstarman commented Jun 6, 2025 •

edited

Loading

34j commented Jun 6, 2025 •

edited

Loading

34j commented Jun 6, 2025 •

edited

Loading

34j commented Jun 6, 2025 •

edited

Loading

nstarman commented Jun 6, 2025 •

edited

Loading

34j commented Jun 7, 2025 •

edited

Loading

34j commented Jun 8, 2025 •

edited

Loading