The template for `pyproject.toml` has been updated
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 70/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- python
调研方向
首先,将此仓库中的 pyproject.toml 与 SciTools/.github 仓库中的 templates/pyproject.toml 进行比较,并以链接的 diff 作为初始范围。在应用相应更改之前,检查项目现有的 Packaging、pytest、repo-review 和 Ruff 设置。完成的标准是更新 pyproject.toml 中适用的约定,或者在没有任何约定适用时关闭 issue。
由索引模型根据 Issue 内容生成。
描述
Templating
The template for pyproject.toml has been updated; see the diff below. Please either:
- Action this issue with a pull request applying some/all of these changes to
pyproject.toml[^1]. - Close this issue if none of these changes are appropriate for this repo.
Also consider reviewing a full diff between the template and pyproject.toml, in case other valuable shared conventions have previously been missed.
File Links
- The file in this repo:
pyproject.toml - The template file in the .github repo:
templates/pyproject.toml
Diff
diff --git a/templates/pyproject.toml b/templates/pyproject.toml
index 5eedf89..be8dc70 100644
--- a/templates/pyproject.toml
+++ b/templates/pyproject.toml
@@ -36,7 +36,7 @@ keywords = [
]
license = "BSD-3-Clause"
license-files = ["LICENSE"]
-name = "scitools-<PACKAGE_NAME>" #e.g "scitools-iris"
+name = "<PACKAGE_NAME>" # e.g "scitools-iris", "cf-units"
requires-python = "<MIN_PYTHON_VERSION>"
[project.urls]
@@ -117,6 +117,7 @@ checks = [
# -> No Yields section found
"YD01", # Not all docstrings require a "Yields" section.
+ # TODO: exceptions that still need investigating are below. Might be fixable, or might become permanent (above):
]
exclude = [
'\.__eq__$',
@@ -126,17 +127,22 @@ exclude = [
[tool.pytest.ini_options] # The list of keys vary by repository
addopts = ["-ra", "-v", "--strict-config", "--strict-markers", "--doctest-modules"] # This addopts list varies by repository
-testpaths = "<PATH_TO_MAIN_CODE>" # e.g "cf_units" or "lib/iris"
+filterwarnings = ["default"]
log_level = "INFO"
+minversion = "6.0"
+testpaths = "<PATH_TO_MAIN_CODE>" # e.g "cf_units" or "lib/iris"
+xfail_strict = "True"
[tool.repo-review]
-# A list of the currently failing repo-review checks, to be fixed later, different for every repository.
+# We have agreed that we will permanently ignore the repo-review rules in the first half of this ignore list.
ignore = [
# https://learn.scientific-python.org/development/guides/style/#PC180
# Not possible to run on the hardware used by the majority of our developers. Might change in future!
"PC180", # Uses prettier.
# https://learn.scientific-python.org/development/guides/packaging-simple#PP006
"PP006", # Uses dev dependency group
+
+ # TODO: exceptions that still need investigating are below. Might be fixable, or might become permanent (above):
]
[tool.ruff]
@@ -146,10 +152,8 @@ line-length = 88
preview = false
[tool.ruff.lint]
-# We have agreed that we will permanently ignore the ruff rules in this ignore list.
+# We have agreed that we will permanently ignore the ruff rules in the first half of this ignore list.
ignore = [
- # NOTE: Non-permanent exclusions should be added to the ".ruff.toml" file.
-
# flake8-commas (COM)
# https://docs.astral.sh/ruff/rules/#flake8-commas-com
"COM812", # Trailing comma missing.
@@ -159,6 +163,8 @@ ignore = [
# https://docs.astral.sh/ruff/rules/single-line-implicit-string-concatenation/
# NOTE: This rule may cause conflicts when used with "ruff format".
"ISC001", # Implicitly concatenate string literals on one line.
+
+ # TODO: exceptions that still need investigating are below. Might be fixable, or might become permanent (above):
]
preview = false
select = [
[^1]: Include this text in the PR body to avoid any prompts about applying your changes back to the template!
@scitools-templating: please no share prompt
- 主要语言
- Jupyter Notebook
- 星标
- 30
- 派生
- 19
- 平均合并
- 9 天 1 小时
- 30 天内合并 PR
- 2
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
SciTools/python-stratify 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
SciTools/python-stratify#437 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
SciTools/python-stratify#435 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
SciTools/python-stratify#430 ·
-
难度 5/5 一周以上 新手友好度 25/100
SciTools/python-stratify#277 ·
-
难度 5/5 一周以上 新手友好度 25/100
SciTools/python-stratify#111 · 3 条评论 · 2 个 reaction ·
查看 SciTools/python-stratify 的全部 Issue
相似的 Issue
-
type/automation type/tech-debt
难度 2/5 1-3 小时 新手友好度 78/100
-
priority: p3
难度 2/5 1-3 小时 新手友好度 72/100
googleapis/librarian#7636 ·
-
package-update
难度 2/5 1-3 小时 新手友好度 72/100
oSoWoSo/vOid_Community_repOsitory#147 · 1 条评论 ·
-
Builders
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 2/5 1-3 小时 新手友好度 88/100