The template for `pyproject.toml` has been updated

Abierto Apto para principiantes
#427 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
70/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
python

Línea de trabajo

Comienza comparando pyproject.toml de este repositorio con templates/pyproject.toml del repositorio SciTools/.github, usando el diff enlazado como alcance inicial. Revisa la configuración existente del proyecto para Packaging, pytest, repo-review y Ruff antes de aplicar los cambios correspondientes. Se considera terminado cuando se actualicen las convenciones aplicables en pyproject.toml o se cierre el issue si no se aplica ninguna.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

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

Lenguaje dominante
Jupyter Notebook
Estrellas
30
Forks
19
Merge medio
9 d 1 h
PR fusionados (30 d)
2

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de SciTools/python-stratify

Todos los issues de SciTools/python-stratify

Issues similares

Más issues de Build System

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.