Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Scientific Python SPEC0 instead of NEP29 #51

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

cgohlke
Copy link
Member

@cgohlke cgohlke commented Apr 4, 2024

Description

Numpy's NEP29 is superseded by the Scientific Python SPEC 0 — Minimum Supported Dependencies guideline.

Also mention the Scientific Python development guide, which competes (?) with the pyOpenSci Python Package Guide.

The Scientific Python project provides a repo-review tool, which we might want to check.

Release note

Summarize the changes in the code block below to be included in the
release notes:

Use Scientific Python SPEC0 instead of NEP29

Checklist

  • The pull request title, summary, and description are concise.
  • Related issues are linked in the description.
  • New dependencies are explained.
  • The source code and documentation can be distributed under the MIT license.
  • The source code adheres to code standards.
  • New classes, functions, and features are thoroughly tested.
  • New, user-facing classes, functions, and features are documented.
  • New features are covered in tutorials.
  • No files other than source code, documentation, and project settings are added to the repository.

Also mention Scientific Python development guide.
@cgohlke cgohlke added the documentation Improvements or additions to documentation label Apr 4, 2024
@cgohlke cgohlke self-assigned this Apr 4, 2024
Copy link
Contributor

@bruno-pannunzio bruno-pannunzio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @cgohlke. I need to read into more detail the SPEC0 guidelines but it seems a good idea to adopt them if there is were the community is going.

The repo-review tool is a very good idea. We might think of implementing it in the short term, but we can discuss it in the next meeting and how to tackle the aspects that don't comply with the guidelines.

@cgohlke cgohlke merged commit db5bd24 into phasorpy:main Apr 5, 2024
13 checks passed
@cgohlke cgohlke deleted the nep29 branch April 5, 2024 16:14
@cgohlke
Copy link
Member Author

cgohlke commented Apr 5, 2024

We already loosely follow these guides. The guides are a good read, but generally opinionated and constantly changing. The only real issue raised by the repo-review tool is pre-commit. I use scripts instead, but for other contributors it might be convenient. We already discussed using ruff instead of black in the future. We can discuss adopting the stricter MyPy rules: enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"].

@cgohlke cgohlke mentioned this pull request Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants