From bf240bda77d6f258353a45a24f9e5fe0e6d0b9aa Mon Sep 17 00:00:00 2001 From: Cale Kochenour Date: Sun, 24 Mar 2024 11:09:42 -0600 Subject: [PATCH 01/38] Add command line reference guide --- index.md | 9 +++ tutorials/command-line-reference.md | 85 +++++++++++++++++++++++++++++ tutorials/intro.md | 7 +++ 3 files changed, 101 insertions(+) create mode 100644 tutorials/command-line-reference.md diff --git a/index.md b/index.md index 24176e3a..139d07d4 100644 --- a/index.md +++ b/index.md @@ -97,6 +97,15 @@ by the community now! Join our community review process or watch development of ::: :::: +::::{grid-item} +:::{card} ✿ Reference Guides ✿ +:class-card: left-aligned + +* [Command Line Reference Guide](/tutorials/command-line-reference) + +::: +:::: + ::::: diff --git a/tutorials/command-line-reference.md b/tutorials/command-line-reference.md new file mode 100644 index 00000000..489cc10d --- /dev/null +++ b/tutorials/command-line-reference.md @@ -0,0 +1,85 @@ +# Command Line Reference Guide + +```{important} +**What these tables are:** These tables summarize the command line inputs (e.g., `pipx install hatch`, `hatch build`) necessary to complete all steps in the package creation process, from installing Hatch to publishing the package on PyPI and conda-forge. + +**What these tables are not:** These tables do not cover the manual/non-automated steps (e.g., update `pyproject.toml` file, create PyPI account, create PyPI API token) you have to complete throughout the package creation process. +``` + +## Environment Setup + +:::{table} +:widths: auto +:align: center + +| Description | Syntax | +|---|---| +| Set PowerShell execution policy | `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` | +| Install Scoop | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` | +| Add "main" bucket as download source | `scoop bucket add main` | +| Add "versions" bucket as download source | `scoop bucket add versions` | +| Install pipx | `scoop install pipx`or `scoop install main/pipx` | +| Install python | `scoop install python` or `scoop install main/python` | +| Install specific python version | `scoop install versions/python311` | +| Update PATH variable with pipx directory | `pipx ensurepath` | +| Install hatch | `pipx install hatch` | +| List hatch commands | `hatch -h` | +| Open location of hatch config file | `hatch config explore` | +| Print contents of hatch config file | `hatch config show` | +| Install grayskull | `pipx install grayskull` | + +::: + +## Package Development + +:::{table} +:widths: auto +:align: center + +| Description | Syntax | +|---|---| +| Create package structure and baseline contents | `hatch new [PACKAGE_NAME]` | +| Install package locally in editable mode | `python -m pip install -e .` | +| List packages installed in current environment | `pip list` | +| Install package from GitHub | `pip install git+https://github.com/user/repo.git@branch_or_tag` | +| Create development environment | `hatch env create` | +| Activate development environment | `hatch shell` | +| Exit development environment | `exit` | + +::: + +## Package Publishing + +:::{table} +:widths: auto +:align: center + +| Description | Syntax | +|---|---| +| Build package sdist and wheel distributions | `hatch build` | +| Publish package to Test PyPI | `hatch publish -r test` | +| Install package from Test PyPI | `pip install -i https://test.pypi.org/simple/ [PACKAGE_NAME]` | +| Publish package to PyPI | `hatch publish` | +| Install package from PyPI | `pip install -i https://pypi.org/simple/ [PACKAGE_NAME]` | +| Create conda-forge recipe | `grayskull pypi [PACKAGE_NAME]` | +| Check that package installs properly | `pip check` | +| Install package from conda-forge | `conda install -c conda-forge [PACKAGE_NAME]` | + +::: + +## Miscellaneous Commands + +:::{table} +:widths: auto +:align: center + +| Description | Syntax | +|---|---| +| View environments hatch has access to | `hatch env show` | +| Print path to active hatch environment | `hatch env find` | +| Bump package version - major | `hatch version major` | +| Bump package version - minor | `hatch version minor` | +| Bump package version - patch | `hatch version patch` | +| Run test scripts on multiple Python versions | `hatch run all:[SCRIPT_NAME]` | + +::: diff --git a/tutorials/intro.md b/tutorials/intro.md index c324510c..db6cff1d 100644 --- a/tutorials/intro.md +++ b/tutorials/intro.md @@ -50,6 +50,13 @@ Add a license & code of conduct Update metadata in pyproject.toml ::: +:::{toctree} +:hidden: +:caption: Reference Guides + +Command Line Reference Guide +::: + :::{admonition} Learning Objectives This lesson introduces you to the basic components of a Python package. From 4246a654edd15ded001d4e6dc6f9acc8fe7eb5be Mon Sep 17 00:00:00 2001 From: Cale Kochenour Date: Sun, 24 Mar 2024 12:29:09 -0600 Subject: [PATCH 02/38] Cleanup --- tutorials/command-line-reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/command-line-reference.md b/tutorials/command-line-reference.md index 489cc10d..ef3dff0a 100644 --- a/tutorials/command-line-reference.md +++ b/tutorials/command-line-reference.md @@ -3,7 +3,7 @@ ```{important} **What these tables are:** These tables summarize the command line inputs (e.g., `pipx install hatch`, `hatch build`) necessary to complete all steps in the package creation process, from installing Hatch to publishing the package on PyPI and conda-forge. -**What these tables are not:** These tables do not cover the manual/non-automated steps (e.g., update `pyproject.toml` file, create PyPI account, create PyPI API token) you have to complete throughout the package creation process. +**What these tables are not:** These tables do not cover the manual/non-automated steps (create PyPI account, create PyPI API token) you have to complete throughout the package creation process. ``` ## Environment Setup @@ -18,7 +18,7 @@ | Install Scoop | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` | | Add "main" bucket as download source | `scoop bucket add main` | | Add "versions" bucket as download source | `scoop bucket add versions` | -| Install pipx | `scoop install pipx`or `scoop install main/pipx` | +| Install pipx | `scoop install pipx` or `scoop install main/pipx` | | Install python | `scoop install python` or `scoop install main/python` | | Install specific python version | `scoop install versions/python311` | | Update PATH variable with pipx directory | `pipx ensurepath` | From 74fa62b7e2611f1dd586fc3e5d015b49315ac85f Mon Sep 17 00:00:00 2001 From: Cale Kochenour Date: Sun, 24 Mar 2024 12:32:12 -0600 Subject: [PATCH 03/38] Cleanup --- tutorials/command-line-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/command-line-reference.md b/tutorials/command-line-reference.md index ef3dff0a..e43649a1 100644 --- a/tutorials/command-line-reference.md +++ b/tutorials/command-line-reference.md @@ -3,7 +3,7 @@ ```{important} **What these tables are:** These tables summarize the command line inputs (e.g., `pipx install hatch`, `hatch build`) necessary to complete all steps in the package creation process, from installing Hatch to publishing the package on PyPI and conda-forge. -**What these tables are not:** These tables do not cover the manual/non-automated steps (create PyPI account, create PyPI API token) you have to complete throughout the package creation process. +**What these tables are not:** These tables do not cover the manual/non-automated steps (e.g., create PyPI account, create PyPI API token) you have to complete throughout the package creation process. ``` ## Environment Setup From 797fa24139cced667b2eab422fd807bd8014e8df Mon Sep 17 00:00:00 2001 From: Cale Kochenour Date: Thu, 9 May 2024 19:56:24 -0600 Subject: [PATCH 04/38] Address PR comments --- tutorials/command-line-reference.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/tutorials/command-line-reference.md b/tutorials/command-line-reference.md index e43649a1..f13e4ba6 100644 --- a/tutorials/command-line-reference.md +++ b/tutorials/command-line-reference.md @@ -4,6 +4,8 @@ **What these tables are:** These tables summarize the command line inputs (e.g., `pipx install hatch`, `hatch build`) necessary to complete all steps in the package creation process, from installing Hatch to publishing the package on PyPI and conda-forge. **What these tables are not:** These tables do not cover the manual/non-automated steps (e.g., create PyPI account, create PyPI API token) you have to complete throughout the package creation process. + +**Operating system note:** The current iteration of this guide has been tested on the Windows OS only. Many commands are Windows-specific. OS-specific commands are indicated with parentheses after the description of the command, e.g., [COMMAND_DESCRIPTION] (Windows). Corresponding commands for macOS and Linux will be added in the future. ``` ## Environment Setup @@ -14,19 +16,19 @@ | Description | Syntax | |---|---| -| Set PowerShell execution policy | `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` | -| Install Scoop | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` | -| Add "main" bucket as download source | `scoop bucket add main` | -| Add "versions" bucket as download source | `scoop bucket add versions` | -| Install pipx | `scoop install pipx` or `scoop install main/pipx` | -| Install python | `scoop install python` or `scoop install main/python` | -| Install specific python version | `scoop install versions/python311` | +| Set PowerShell execution policy (Windows) | `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` | +| Install Scoop (Windows) | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` | +| Add "main" bucket as download source (Windows) | `scoop bucket add main` | +| Add "versions" bucket as download source (Windows) | `scoop bucket add versions` | +| Install pipx (Windows) | `scoop install pipx` or `scoop install main/pipx` | +| Install python (Windows) | `scoop install python` or `scoop install main/python` | +| Install specific python version (Windows) | `scoop install versions/python311` | | Update PATH variable with pipx directory | `pipx ensurepath` | -| Install hatch | `pipx install hatch` | +| Install hatch | `pipx install hatch` or `pip install hatch` | | List hatch commands | `hatch -h` | | Open location of hatch config file | `hatch config explore` | | Print contents of hatch config file | `hatch config show` | -| Install grayskull | `pipx install grayskull` | +| Install grayskull | `pipx install grayskull` or `pip install grayskull` | ::: @@ -40,6 +42,7 @@ |---|---| | Create package structure and baseline contents | `hatch new [PACKAGE_NAME]` | | Install package locally in editable mode | `python -m pip install -e .` | +| Install development dependencies | `python -m pip install ".[DEPENDENCY_GROUP]"` | | List packages installed in current environment | `pip list` | | Install package from GitHub | `pip install git+https://github.com/user/repo.git@branch_or_tag` | | Create development environment | `hatch env create` | @@ -67,7 +70,7 @@ ::: -## Miscellaneous Commands +## Versions and Environments :::{table} :widths: auto @@ -75,7 +78,7 @@ | Description | Syntax | |---|---| -| View environments hatch has access to | `hatch env show` | +| View environments | `hatch env show` | | Print path to active hatch environment | `hatch env find` | | Bump package version - major | `hatch version major` | | Bump package version - minor | `hatch version minor` | From f6143b9c863a8a7758180fbc421705cfa13354f8 Mon Sep 17 00:00:00 2001 From: Cale Kochenour Date: Thu, 9 May 2024 20:04:30 -0600 Subject: [PATCH 05/38] Cleanup --- tutorials/command-line-reference.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/tutorials/command-line-reference.md b/tutorials/command-line-reference.md index f13e4ba6..2d7788fb 100644 --- a/tutorials/command-line-reference.md +++ b/tutorials/command-line-reference.md @@ -21,8 +21,6 @@ | Add "main" bucket as download source (Windows) | `scoop bucket add main` | | Add "versions" bucket as download source (Windows) | `scoop bucket add versions` | | Install pipx (Windows) | `scoop install pipx` or `scoop install main/pipx` | -| Install python (Windows) | `scoop install python` or `scoop install main/python` | -| Install specific python version (Windows) | `scoop install versions/python311` | | Update PATH variable with pipx directory | `pipx ensurepath` | | Install hatch | `pipx install hatch` or `pip install hatch` | | List hatch commands | `hatch -h` | From d0f63e404f9579daf5f156f7c2796678c3e81c1c Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Sun, 14 Jul 2024 19:54:29 +0200 Subject: [PATCH 06/38] docs: translate to Spanish python-package-distribution-files-sdist-wheel.md file --- .../es/LC_MESSAGES/package-structure-code.po | 188 ++++++++++++++++-- 1 file changed, 166 insertions(+), 22 deletions(-) diff --git a/locales/es/LC_MESSAGES/package-structure-code.po b/locales/es/LC_MESSAGES/package-structure-code.po index 90bc3f35..06cb55d2 100644 --- a/locales/es/LC_MESSAGES/package-structure-code.po +++ b/locales/es/LC_MESSAGES/package-structure-code.po @@ -3907,7 +3907,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:1 msgid "Learn about Building a Python Package" -msgstr "" +msgstr "Aprenda sobre la construcción de un paquete de Python" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:8 msgid "" @@ -3917,6 +3917,9 @@ msgid "" "your package on conda-forge. You do not need to rebuild your package to " "publish to conda-forge." msgstr "" +"Una vez que haya publicado ambas distribuciones de paquetes (la distribución de origen y la rueda) en PyPI, " +"entonces puede publicar en conda-forge. conda-forge requiere una distribución de origen en PyPI para construir su " +"paquete en conda-forge. No necesita reconstruir su paquete para publicar en conda-forge." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:11 msgid "" @@ -3927,20 +3930,28 @@ msgid "" "PyPI in order for conda-forge to properly build your package " "automatically." msgstr "" +"Necesita construir su paquete de Python para publicarlo en PyPI " +"(o en un canal de conda). El proceso de construcción organiza su código " +"y metadatos en un formato de distribución que puede ser subido a PyPI y " +"posteriormente descargado e instalado por los usuarios. NOTA: necesita " +"publicar un sdist en PyPI para que conda-forge pueda construir su paquete " +"automáticamente." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:14 msgid "What is building a Python package?" -msgstr "" +msgstr "¿Qué es construir un paquete de Python?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:16 msgid "" "To [publish your Python package](publish-python-package-pypi-conda) and " "make it easy for anyone to install, you first need to build it." msgstr "" +"Para [publicar su paquete de Python](publish-python-package-pypi-conda) y " +"hacer que sea fácil de instalar para cualquiera, primero necesita construirlo." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:18 msgid "But, what does it mean to build a Python package?" -msgstr "" +msgstr "Per, ¿qué significa construir un paquete de Python?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:20 msgid "" @@ -3950,6 +3961,11 @@ msgid "" "and metadata about the package, in the format required by the Python " "Package Index, so that it can be installed by tools like pip." msgstr "" +"[Como se muestra en la figura de arriba](#pypi-conda-channels), cuando construye su paquete de Python, convierte " +"los archivos de código fuente en algo llamado paquete de distribución." +" Un paquete de distribución contiene su código fuente " +"y metadatos sobre el paquete, en el formato requerido por el Índice de Paquetes de Python, para que pueda ser " +"instalado por herramientas como pip." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:23 msgid "" @@ -3958,6 +3974,9 @@ msgid "" " Authority](https://www.pypa.io/en/latest/) and refer to the product of " "the build step as a **distribution package**." msgstr "" +"El término paquete solía significar muchas cosas diferentes en Python y otros lenguajes. En esta página, " +"adaptamos la convención de la [Autoridad de Empaquetado de Python](https://www.pypa.io/en/latest/) y nos referimos " +"al producto del paso de construcción como un **paquete de distribución**." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:27 msgid "" @@ -3965,10 +3984,12 @@ msgid "" " and metadata into a format that both pip and PyPI can use, is called a " "build step." msgstr "" +"Este proceso de organizar y formatear su código, documentación, pruebas y metadatos en un formato que tanto pip " +"como PyPI pueden usar, se llama paso de construcción." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:31 msgid "Project metadata and PyPI" -msgstr "" +msgstr "Metadatos del proyecto y PyPI" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:33 msgid "" @@ -3977,6 +3998,9 @@ msgid "" "](pyproject-toml-python-package-metadata). This metadata is used for " "several purposes:" msgstr "" +"Los metadatos que tanto las herramientas de construcción como PyPI utilizan para describir y entender su paquete " +"generalmente se almacenan en un [archivo pyproject.toml](pyproject-toml-python-package-metadata). Estos metadatos " +"se utilizan para varios propósitos:" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:35 msgid "" @@ -3985,6 +4009,9 @@ msgid "" "poetry, PDM or Hatch) understand how to build your package. Information " "it provides to your build tool includes:" msgstr "" +"Ayuda a la herramienta que use para construir su paquete (pip, [Build de pypa](https://pypi.org/project/build/) o " +"una herramienta de extremo a extremo como poetry, PDM o Hatch) a entender cómo construir su paquete. La información " +"que proporciona a su herramienta de construcción incluye:" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:37 msgid "" @@ -3992,12 +4019,16 @@ msgid "" "[build backend tool](build_backends) you wish to use for creating your " "sdist and wheel distributions." msgstr "" +"La tabla `[build-system]` en su archivo pyproject.toml le dice a pip qué [herramienta de backend de construcción]" +"(build_backends) desea usar para crear sus distribuciones sdist y wheel." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:45 msgid "" "And the dependencies section of your project table tells the build tool " "and PyPI what dependencies your project requires." msgstr "" +"Y la sección de dependencias de su tabla de proyecto le dice a la herramienta de construcción y a PyPI qué " +"dependencias requiere su proyecto." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:54 msgid "" @@ -4005,6 +4036,9 @@ msgid "" " you publish on PyPI), it also creates a METADATA file which PyPI can " "read and use to help users find your package. For example:" msgstr "" +"Cuando la herramienta de construcción crea el archivo de distribución de su paquete (el archivo que publica en " +"PyPI), también crea un archivo METADATA que PyPI puede leer y usar para ayudar a los usuarios a encontrar su paquete. " +"Por ejemplo:" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:56 msgid "" @@ -4013,10 +4047,13 @@ msgid "" "filter for packages that contain specific licenses or that support " "specific versions of python." msgstr "" +"La sección `classifiers = ` de su tabla `[project]` en el archivo pyproject.toml proporciona información que los " +"usuarios en PyPI pueden usar para filtrar paquetes que contienen licencias específicas o que admiten versiones " +"específicas de Python." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:73 msgid "What happened to setup.py and setup.cfg for metadata?" -msgstr "" +msgstr "¿Qué pasó con setup.py y setup.cfg para almacenar metadatos?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:76 msgid "" @@ -4025,10 +4062,13 @@ msgid "" "metadata is to use a pyproject.toml file. [Learn more about the " "pyproject.toml file here.](pyproject-toml-python-package-metadata)" msgstr "" +"Los metadatos del proyecto solían almacenarse en un archivo setup.py o en un archivo setup.cfg. La práctica " +"recomendada actual para almacenar metadatos de paquetes es utilizar un archivo pyproject.toml. [Aprenda más sobre el " +"archivo pyproject.toml aquí.](pyproject-toml-python-package-metadata)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:79 msgid "An example - xclim" -msgstr "" +msgstr "Un ejemplo - xclim" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:94 msgid "" @@ -4041,6 +4081,15 @@ msgid "" "connect to conda-forge for an automated build that sends distributions " "from PyPI to conda-forge." msgstr "" +"Gráfico que muestra el flujo de trabajo de empaquetado de alto nivel." +" A la izquierda se ve un gráfico con código, metadatos y tests en él. " +"Esos elementos van todos en su paquete. La documentación y los datos " +"están debajo de esa recuadro porque normalmente no se publican en su " +"distribución de rueda de empaquetado. Una flecha a la derecha lo lleva a " +"un cuadro de archivos de distribución de construcción. Ese cuadro lo lleva " +"a publicar en TestPyPI o en el verdadero PyPI. Desde PyPI, puede conectarse " +"a conda-forge para una construcción automatizada que envía distribuciones " +"de PyPI a conda-forge." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:96 msgid "" @@ -4051,6 +4100,11 @@ msgid "" "PyPI in order for conda-forge to properly build your package " "automatically." msgstr "" +"Necesita construir su paquete de Python para publicarlo en PyPI (o Conda). " +"El proceso de construcción organiza su código y metadatos en un formato de " +"distribución que puede ser subido a PyPI y posteriormente descargado e " +"instalado por los usuarios. NOTA: necesita publicar un sdist en PyPI para " +"que conda-forge pueda construir su paquete automáticamente." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:101 msgid "" @@ -4059,10 +4113,14 @@ msgid "" "keywords associated with the package and the base python version it " "requires which is 3.8." msgstr "" +"Esta captura de pantalla muestra los metadatos en PyPI para el paquete xclim. " +"En ella puede ver el nombre de la licencia, los nombres del autor y del " +"mantenedor, palabras clave asociadas con el paquete y la versión base de " +"Python que requiere, que es 3.8." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:103 msgid "PyPI screenshot showing metadata for the xclim package." -msgstr "" +msgstr "Captura de pantalla de PyPI que muestra metadatos para el paquete xclim." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:110 msgid "" @@ -4070,6 +4128,9 @@ msgid "" "xclim there are three maintainers listed with their profile pictures and " "github user names to the right." msgstr "" +"Aquí ve los metadatos del mantenedor tal como se muestran en PyPI. Para " +"xclim hay tres mantenedores listados con sus fotos de perfil y nombres de " +"usuario de GitHub a la derecha." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:112 msgid "" @@ -4078,10 +4139,14 @@ msgid "" "and then processed by your build tool and stored in your packages sdist " "and wheel distributions." msgstr "" +"Nombres de los mantenedores y nombres de usuario de GitHub para el paquete " +"xclim tal como se muestran en PyPI. Esta información se registra en su " +"pyproject.toml y luego es procesada por su herramienta de construcción y " +"almacenada en las distribuciones sdist y wheel (o rueda) de sus paquetes." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:115 msgid "How to create the distribution format that PyPI and Pip expects?" -msgstr "" +msgstr "¿Cómo crear el formato de distribución que PyPI y Pip esperan?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:117 msgid "" @@ -4091,6 +4156,11 @@ msgid "" "there are packages and tools that help you create package build " "distribution files." msgstr "" +"En teoría, podría crear sus propios scripts para organizar su código " +"de la manera que PyPI quiere que sea. Sin embargo, al igual que hay " +"paquetes que manejan estructuras conocidas como Pandas para marcos " +"de datos y Numpy para matrices, hay paquetes y herramientas que le " +"ayudan a crear archivos de distribución de construcción de paquetes." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:121 msgid "" @@ -4100,6 +4170,11 @@ msgid "" "your sdist and wheel. Whereas tools like Hatch, PDM, Poetry and flit help" " with other parts of the packaging process." msgstr "" +"Existen una serie de herramientas de empaquetado que pueden ayudarlo con " +"todo el proceso de empaquetado o solo con un paso del proceso. Por ejemplo, " +"setuptools es un backend de construcción comúnmente utilizado que se puede " +"usar para crear su sdist y wheel (o rueda). Mientras que herramientas como " +"Hatch, PDM, Poetry y flit ayudan con otras partes del proceso de empaquetado." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:127 msgid "" @@ -4108,6 +4183,11 @@ msgid "" "output (with minor differences that most users may not care about). Learn" " more about those tools on this page." msgstr "" +"Si bien esto puede causar cierta confusión y complejidad en el ecosistema " +"de empaquetado, en su mayor parte, cada herramienta proporciona la misma " +"salida de distribución (con diferencias menores que a la mayoría de los " +"usuarios pueden no importarles). Aprenda más sobre esas herramientas en " +"esta página." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:133 msgid "" @@ -4115,6 +4195,9 @@ msgid "" "you to publish: sdist and wheel. You will learn about their structure and" " what files belong in each." msgstr "" +"A continuación, aprenderá sobre los dos archivos de distribución que PyPI " +"espera que publique: sdist y wheel (o rueda). Aprenderá sobre su estructura " +"y qué archivos pertenecen a cada uno." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:136 msgid "" @@ -4124,10 +4207,16 @@ msgid "" "wheel (.whl) contains the built / compiled files that can be directly " "installed onto anyones' computer." msgstr "" +"Hay dos archivos de distribución principales que necesita crear para " +"publicar su paquete de Python en PyPI: la distribución de origen (a menudo " +"llamada sdist) y la rueda (o wheel). El sdist contiene el código fuente " +"sin procesar de su paquete. La rueda (.whl) contiene los archivos " +"construidos / compilados que se pueden instalar directamente en el " +"ordenador de cualquier persona." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:142 msgid "Learn more about both distributions below." -msgstr "" +msgstr "Aprenda más sobre ambas distribuciones a continuación." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:145 msgid "" @@ -4137,6 +4226,11 @@ msgid "" "languages or is more complex in its build, the two distributions will be " "very different." msgstr "" +"Si su paquete es un paquete de Python puro sin pasos adicionales de " +"construcción / compilación, entonces las distribuciones sdist y wheel " +"tendrán contenido similar. Sin embargo, si su paquete tiene extensiones en " +"otros lenguajes o es más complejo en su construcción, las dos distribuciones " +"serán muy diferentes." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:150 msgid "" @@ -4145,10 +4239,14 @@ msgid "" "here.](https://conda.io/projects/conda-build/en/latest/user-" "guide/tutorials/index.html)" msgstr "" +"También tenga en cuenta que no estamos discutiendo flujos de trabajo de " +"construcción de conda en esta sección. [Puede aprender más sobre las " +"construcciones de conda aquí.](https://conda.io/projects/conda-build/en/" +"latest/user-guide/tutorials/index.html)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:155 msgid "Source Distribution (sdist)" -msgstr "" +msgstr "Distribución de origen (sdist)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:157 msgid "" @@ -4156,6 +4254,10 @@ msgid "" "These are the \"raw / as-is\" files that you store on GitHub or whatever " "platform you use to manage your code." msgstr "" +"Los **archivos de origen** son los archivos sin construir necesarios para " +"construir su paquete. Estos son los archivos \"crudos / tal como están\" " +"que almacena en GitHub o en cualquier plataforma que utilice para gestionar " +"su código." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:161 msgid "" @@ -4167,6 +4269,12 @@ msgid "" "everything required to build a wheel (except for project dependencies) " "without network access." msgstr "" +"Las distribuciones de origen (del inglés, _source distribution_) se denominan sdist. Como " +"su nombre indica, un SDIST contiene el código fuente; no ha sido construido ni" +" compilado de ninguna manera. Por lo tanto, cuando un usuario instala su distribución de origen " +"usando pip, pip necesita ejecutar un paso de construcción primero. Por esta razón, " +"podría definir una distribución de origen como un archivo comprimido que contiene todo lo " +"necesario para construir una rueda (excepto las dependencias del proyecto) sin acceso a la red." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:165 msgid "" @@ -4174,14 +4282,17 @@ msgid "" "\"tarball\"). Thus, when a user installs your source distribution using " "pip, pip needs to run a build step first." msgstr "" +"Normalmente, sdist se almacena como un archivo `.tar.gz` (a menudo llamado " +"un \"tarball\"). Por lo tanto, cuando un usuario instala su distribución de origen " +"usando pip, pip necesita ejecutar un paso de construcción primero." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:167 msgid "Below is an example sdist for the stravalib Python package:" -msgstr "" +msgstr "A continuación se muestra un ejemplo de sdist para el paquete de Python stravalib:" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:219 msgid "GitHub archive vs sdist" -msgstr "" +msgstr "El archivo de GitHub vs sdist" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:221 msgid "" @@ -4192,10 +4303,16 @@ msgid "" "`setuptools_scm` or `hatch_vcs` the sdist may also contain a file that " "stores the version." msgstr "" +"Cuando se crea una versión en GitHub, se crea un `git archive` que contiene " +"todos los archivos de su repositorio de GitHub. Si bien estos archivos son " +"similares a un sdist, estos dos archivos no son iguales. El sdist contiene " +"algunos otros elementos, incluido un directorio de metadatos y si utiliza " +"`setuptools_scm` o `hatch_vcs`, el sdist también puede contener un archivo " +"que almacena la versión." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:229 msgid "Wheel (.whl files):" -msgstr "" +msgstr "Rueda o _wheel_(.whl files):" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:231 msgid "" @@ -4206,6 +4323,13 @@ msgid "" "may be included in source distributions are not included in wheels " "because it is a built distribution." msgstr "" +"Un archivo de rueda es un archivo en formato ZIP cuyo nombre sigue" +" un formato específico (a continuación) y tiene la " +"extensión `.whl`. El archivo `.whl` contiene un conjunto específico de " +"archivos, incluidos metadatos que se generan a partir del archivo " +"pyproject.toml de su proyecto. El pyproject.toml y otros archivos que " +"pueden estar incluidos en las distribuciones de origen no se incluyen en " +"las ruedas porque es una distribución construida." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:238 msgid "" @@ -4217,6 +4341,14 @@ msgid "" "thus faster to install - particularly if you have a package that requires" " build steps." msgstr "" +"La rueda (.whl) es su distribución binaria construida. Los" +" **archivos binarios** son los archivos de código fuente " +"construidos / compilados. Estos archivos están listos para ser instalados." +" Una rueda (**.whl**) es un archivo **zip** que contiene todos los archivos " +"necesarios para instalar directamente su paquete. Todos los archivos en una " +"rueda son binarios, lo que significa que el código ya está compilado / " +"construido. Por lo tanto, las ruedas son más rápidas de instalar, " +"particularmente si tiene un paquete que requiere pasos de construcción." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:240 msgid "" @@ -4224,12 +4356,17 @@ msgid "" " as **setup.cfg** or **pyproject.toml**. This distribution is already " "built so it's ready to install." msgstr "" +"La rueda no contiene ninguno de los archivos de configuración de su paquete " +"como **setup.cfg** o **pyproject.toml**. Esta distribución ya está construida " +"por lo que está lista para instalar." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:244 msgid "" "Because it is built, the wheel file will be faster to install for pure " "Python projects and can lead to consistent installs across machines." msgstr "" +"Debido a que está construido, el archivo .whl será más rápido de instalar " +"para proyectos de Python puro y llevará a instalaciones consistentes " #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:252 msgid "" @@ -4238,48 +4375,55 @@ msgid "" "the wheel bundle are pre built, the user installing doesn't have to worry" " about malicious code injections when it is installed." msgstr "" +"Las ruedas también son útiles en el caso de que un paquete necesite un " +"archivo **setup.py** para admitir una construcción más compleja. En este " +"caso, debido a que los archivos en el paquete de rueda están preconstruidos, " +"el usuario que lo instala no tiene que preocuparse por inyecciones de código " +"malicioso cuando se instala." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:259 msgid "The filename of a wheel contains important metadata about your package." -msgstr "" +msgstr "El nombre de archivo de una rueda contiene metadatos importantes sobre su paquete." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:261 msgid "Example: **stravalib-1.1.0.post2-py3-none.whl**" -msgstr "" +msgstr "Por ejemplo: **stravalib-1.1.0.post2-py3-none.whl**" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:263 msgid "name: stravalib" -msgstr "" +msgstr "nombre: stravalib" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:264 msgid "version: 1.1.0" -msgstr "" +msgstr "versión: 1.1.0" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:265 msgid "" "build-number: 2 (post2) [(read more about post " "here)](https://peps.python.org/pep-0440/#post-release-separators)" msgstr "" +"número de construcción: 2 (post2) [(lea más sobre post " +"aquí)](https://peps.python.org/pep-0440/#post-release-separators)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:266 msgid "py3: supports Python 3.x" -msgstr "" +msgstr "py3: admite Python 3.x" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:267 msgid "none: is not operating system specific (runs on windows, mac, linux)" -msgstr "" +msgstr "none: no es específico del sistema operativo (se ejecuta en Windows, Mac, Linux)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:268 msgid "any: runs on any computer processor / architecture" -msgstr "" +msgstr "any: se ejecuta en cualquier procesador / arquitectura de ordenador" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:270 msgid "What a wheel file looks like when unpacked (unzipped):" -msgstr "" +msgstr "¿Cómo se ve un archivo de rueda cuando se desempaqueta (descomprime)?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:304 msgid "[Read more about the wheel format here](https://pythonwheels.com/)" -msgstr "" +msgstr "[Lea más sobre el formato de rueda aquí](https://pythonwheels.com/)" #: ../../package-structure-code/python-package-structure.md:1 msgid "Python Package Structure for Scientific Python Projects" From 905743fdf546ee65b16f73522d646393f931de19 Mon Sep 17 00:00:00 2001 From: ncclementi Date: Sun, 14 Jul 2024 11:46:18 -0700 Subject: [PATCH 07/38] translate tutorials page --- locales/es/LC_MESSAGES/tutorials.po | 47 ++++++++++++++++++----------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index 3427e46d..62ca6bbc 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -22,70 +22,77 @@ msgstr "" #: ../../tutorials/add-license-coc.md:1 msgid "Add a `LICENSE` & `CODE_OF_CONDUCT` to your Python package" -msgstr "" +msgstr "Agrega `LICENSE` y `CODE_OF_CONDUCT` a tu paquete de Python" #: ../../tutorials/add-license-coc.md:3 msgid "In the [previous lesson](add-readme) you:" -msgstr "" +msgstr "En la [sección anterior](add-readme) tu:" #: ../../tutorials/add-license-coc.md:5 msgid "" " " "Created a basic `README.md` file for your scientific Python package" -msgstr "" +msgstr "Creaste un archivo `README.md` para tu paquete the Python científico" #: ../../tutorials/add-license-coc.md:7 msgid "" " " "Learned about the core components that are useful to have in a `README` " "file." -msgstr "" +msgstr "Aprendiste acerca de los componentes principales que son útiles de tener en " +"un `README` file." #: ../../tutorials/add-license-coc.md:9 ../../tutorials/add-readme.md:10 msgid "Learning objectives" -msgstr "" +msgstr "Objetivos de aprendizaje" #: ../../tutorials/add-license-coc.md:12 ../../tutorials/add-readme.md:12 #: ../../tutorials/installable-code.md:41 ../../tutorials/pyproject-toml.md:22 #: ../../tutorials/setup-py-to-pyproject-toml.md:15 msgid "In this lesson you will learn:" -msgstr "" +msgstr "En esta lección aprenderas:" #: ../../tutorials/add-license-coc.md:14 msgid "" "How to select a license and add a `LICENSE` file to your package " "repository, with a focus on the GitHub interface." -msgstr "" +msgstr "Como seleccionar una licencia y agregar un archivo `LICENSE` al " +"repositorio de tu paquete, con enfoque en la interface de Github" #: ../../tutorials/add-license-coc.md:15 msgid "How to add a `CODE_OF_CONDUCT` file to your package repository." -msgstr "" +msgstr "Como agregar un archivo `CODE_OF_CONDUCT` al repositorio de tu paquete" #: ../../tutorials/add-license-coc.md:16 msgid "" "How you can use the Contributors Covenant website to add generic language" " as a starting place for your `CODE_OF_CONDUCT`." -msgstr "" +msgstr "Como usar el sitio web de Contributors Covenant para agregar lenguage" +" genérico como punto de partida para tu `CODE_OF_CONDUCT`" #: ../../tutorials/add-license-coc.md:19 msgid "What is a license?" -msgstr "" +msgstr "¿Qué es una licencia?" #: ../../tutorials/add-license-coc.md:21 msgid "" "A license contains legal language about how users can use and reuse your " "software. To set the `LICENSE` for your project, you:" -msgstr "" +msgstr "Una licencia contiene lenguage legal acerca de como los usuarios pueden " +"usar y reusar tu software. Para establecer un archivo `LICENSE` para tu" +" projecto, tu: " #: ../../tutorials/add-license-coc.md:23 msgid "" "create a `LICENSE` file in your project directory that specifies the " "license that you choose for your package and" -msgstr "" +msgstr "creas un archivo `LICENSE` en el directorio de tu proyecto que " +"especifique la licencia que que elejiste para tu paquete y" #: ../../tutorials/add-license-coc.md:24 msgid "reference that file in your `pyproject.toml` data where metadata are set." -msgstr "" +msgstr "haces referencia a ese archivo en el `pyproject.toml` donde la metadata" +" es especificada" #: ../../tutorials/add-license-coc.md:26 msgid "" @@ -93,11 +100,14 @@ msgid "" " will be included in your package's metadata which is used to populate " "your package's PyPI landing page. The `LICENSE` is also used in your " "GitHub repository's landing page interface." -msgstr "" +msgstr "Al incluir el archivo `LICENSE` en tu archivo `pyproject.toml`, la " +"`LICENSE` sera incluída en la metadata de tu paquete y esta es utilizada para" +" rellenar la página de entrada de tu paquete en PyPI. La `LICENSE` tambien es " +" utilizada en la página de entrada de tu repositorio de GitHub" #: ../../tutorials/add-license-coc.md:28 msgid "What license should you use?" -msgstr "" +msgstr "¿Qué licencia debería elegir?" #: ../../tutorials/add-license-coc.md:30 msgid "" @@ -105,11 +115,14 @@ msgid "" "most commonly used licenses in the scientific Python ecosystem (MIT[^mit]" " and BSD-3[^bsd3]). If you are unsure, use MIT given it's the generally " "recommended license on [choosealicense.com](https://choosealicense.com/)." -msgstr "" +msgstr "Nosotros sugerimos que uses una licencia permissiva que acomode otras" +" licencias comunmente usadas en el ecosistema de Python científico (MIT[^mit]" +" and BSD-3[^bsd3]). Si tienes dudas, usa MIT dado que es la licencia" +" generalmente recomendada en [choosealicense.com](https://choosealicense.com/)" #: ../../tutorials/add-license-coc.md:33 msgid "Licenses for the scientific Python ecosystem" -msgstr "" +msgstr "Licencias para el ecosistema de Python científico" #: ../../tutorials/add-license-coc.md:34 msgid "" From fc3ad39573db278d040e6a965fff191d44f6cc61 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 6 Aug 2024 17:47:44 -0700 Subject: [PATCH 08/38] Attempt to fix the toctree warning --- tutorials/intro.md | 1 - 1 file changed, 1 deletion(-) diff --git a/tutorials/intro.md b/tutorials/intro.md index 869f351b..95661fa7 100644 --- a/tutorials/intro.md +++ b/tutorials/intro.md @@ -52,7 +52,6 @@ Update metadata in pyproject.toml :::{toctree} :hidden: - :caption: Reference Guides Command Line Reference Guide From b3f7bada167d361bd9be04b84a7d30bb00e50e35 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 9 Aug 2024 13:51:03 +0900 Subject: [PATCH 09/38] Delete duplicate content in a sentence --- TRANSLATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 9fb5e5b2..ed3576f8 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -340,7 +340,7 @@ TODO: There are many approaches here, some projects release a translation as soo ### How can I get help with my translation? -If you have any questions or need help with your translation, you can create an issue in the repository if you encounter any problems or need assistance. +If you have any questions or need help with your translation, you can create an issue in the repository. TODO: Maybe [Discourse](https://pyopensci.discourse.group/) could be used as a way for contributors to ask for help with translations or the translation workflow? From e4d7c26c0226415f2225713afce643e3b59fb519 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Sun, 11 Aug 2024 15:23:13 +0900 Subject: [PATCH 10/38] docs: translate to Japanese index.md --- locales/ja/LC_MESSAGES/index.po | 318 +++++++++++++++++++------------- 1 file changed, 187 insertions(+), 131 deletions(-) diff --git a/locales/ja/LC_MESSAGES/index.po b/locales/ja/LC_MESSAGES/index.po index 379d9450..50c7a478 100644 --- a/locales/ja/LC_MESSAGES/index.po +++ b/locales/ja/LC_MESSAGES/index.po @@ -3,52 +3,55 @@ # This file is distributed under the same license as the pyOpenSci Python # Package Guide package. # FIRST AUTHOR , 2024. -# +# +# Translators: +# Tetsuo Koyama , 2024 +# #, fuzzy msgid "" msgstr "" -"Project-Id-Version: pyOpenSci Python Package Guide \n" +"Project-Id-Version: pyOpenSci Python Package Guide\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-08-02 18:04+0900\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language: ja\n" -"Language-Team: ja \n" -"Plural-Forms: nplurals=1; plural=0;\n" +"PO-Revision-Date: 2024-08-07 23:17+0000\n" +"Last-Translator: Tetsuo Koyama , 2024\n" +"Language-Team: Japanese (https://app.transifex.com/tkoyama010/teams/196662/ja/)\n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.15.0\n" +"Language: ja\n" +"Plural-Forms: nplurals=1; plural=0;\n" #: ../../index.md:283 msgid "Tutorials" -msgstr "" +msgstr "チュートリアル" #: ../../index.md:289 msgid "Packaging" -msgstr "" +msgstr "パッケージング" #: ../../index.md:139 ../../index.md:297 msgid "Documentation" -msgstr "" +msgstr "ドキュメンテーション" #: ../../index.md:187 ../../index.md:305 msgid "Tests" -msgstr "" +msgstr "テスト" #: ../../index.md:305 msgid "Testing" -msgstr "" +msgstr "テスト" #: ../../index.md:1 msgid "pyOpenSci Python Package Guide" -msgstr "" +msgstr "pyOpenSci Pythonパッケージガイド" #: ../../index.md:3 msgid "" "We support the Python tools that scientists need to create open science " "workflows." -msgstr "" +msgstr "私たちは、科学者がオープンサイエンスのワークフローを作成するために必要なPythonツールをサポートしています。" #: ../../index.md:20 msgid "" @@ -59,425 +62,478 @@ msgid "" "guide?style=social)](https://github.com/pyopensci/contributing-guide) " "[![DOI](https://zenodo.org/badge/556814582.svg)](https://zenodo.org/badge/latestdoi/556814582)" msgstr "" +"![GitHub release (latest by " +"date)](https://img.shields.io/github/v/release/pyopensci/python-package-" +"guide?color=purple&display_name=tag&style=plastic) " +"[![](https://img.shields.io/github/stars/pyopensci/python-package-" +"guide?style=social)](https://github.com/pyopensci/contributing-guide) " +"[![DOI](https://zenodo.org/badge/556814582.svg)](https://zenodo.org/badge/latestdoi/556814582)" #: ../../index.md:20 msgid "GitHub release (latest by date)" -msgstr "" +msgstr "GitHubリリース(日付順最新)" #: ../../index.md:20 msgid "DOI" -msgstr "" +msgstr "DOI" #: ../../index.md:27 msgid "About this guide" -msgstr "" +msgstr "このガイドについて" #: ../../index.md:29 msgid "" "Image with the pyOpenSci flower logo in the upper right hand corner. The " -"image shows the packaging lifecycle. The graphic shows a high level " -"overview of the elements of a Python package. the inside circle has 5 " -"items - user documentation, code/api, test suite, contributor " -"documentation, project metadata / license / readme. In the middle of the " -"circle is says maintainers and has a small icon with people. on the " -"outside circle there is an arrow and it says infrastructure." +"image shows the packaging lifecycle. The graphic shows a high level overview" +" of the elements of a Python package. the inside circle has 5 items - user " +"documentation, code/api, test suite, contributor documentation, project " +"metadata / license / readme. In the middle of the circle is says maintainers" +" and has a small icon with people. on the outside circle there is an arrow " +"and it says infrastructure." msgstr "" +"右上にpyOpenSciの花のロゴがある画像。画像はパッケージングのライフサイクルを示しています。図にはPythonパッケージの要素のハイレベルな概要が示されています。内側の円には5つの項目があります" +" - " +"ユーザードキュメント、コード/API、テストスイート、コントリビュータードキュメント、プロジェクトメタデータ/ライセンス/readme。円の真ん中にはメンテナーと書かれ、人と小さなアイコンがあります。外側の円には矢印があり、インフラストラクチャと書かれています。" #: ../../index.md:35 msgid "This guide will help you:" -msgstr "" +msgstr "このガイドはあなたのお役に立つでしょう:" #: ../../index.md:37 msgid "Learn how to create a Python package from start to finish" -msgstr "" +msgstr "Pythonパッケージの作成方法を最初から最後まで学ぶ" #: ../../index.md:38 msgid "Understand the broader Python packaging tool ecosystem" -msgstr "" +msgstr "幅広いPythonパッケージングツールのエコシステムを理解する" #: ../../index.md:39 msgid "Navigate and make decisions around tool options" -msgstr "" +msgstr "ツールオプションのナビゲートと決定" #: ../../index.md:40 -msgid "Understand all of the pieces of creating and maintaining a Python package" -msgstr "" +msgid "" +"Understand all of the pieces of creating and maintaining a Python package" +msgstr "Pythonパッケージの作成と保守のすべてを理解する" #: ../../index.md:42 msgid "" "You will also find best practice recommendations and curated lists of " "community resources surrounding packaging and package documentation." msgstr "" +"また、パッケージングとパッケージドキュメンテーションにまつわるベストプラクティスの推奨や、コミュニティリソースのキュレーションリストもご覧いただけます。" #: ../../index.md:46 msgid "Todo" -msgstr "" +msgstr "Todo" #: ../../index.md:47 msgid "TODO: change the navigation of docs to have a" -msgstr "" +msgstr "TODO: ドキュメントのナビゲーションに" #: ../../index.md:49 msgid "user documentation contributor / maintainer documentation" -msgstr "" +msgstr "ユーザードキュメント コントリビューター / メンテナ ドキュメント" #: ../../index.md:51 msgid "development guide" -msgstr "" +msgstr "開発ガイド" #: ../../index.md:52 msgid "contributing guide" -msgstr "" +msgstr "コントリビュートガイド" #: ../../index.md:54 msgid "Community docs" -msgstr "" +msgstr "コミュニティドキュメント" #: ../../index.md:55 msgid "readme, coc, license" -msgstr "" +msgstr "readme、coc、ライセンス" #: ../../index.md:57 msgid "Publish your docs" -msgstr "" +msgstr "ドキュメントを公開する" #: ../../index.md:59 msgid "_new_ Tutorial Series: Create a Python Package" -msgstr "" +msgstr "_new_ チュートリアルシリーズ: Pythonパッケージの作成" #: ../../index.md:61 msgid "" -"The first round of our community-developed, how to create a Python " -"package tutorial series for scientists is complete! Join our community " -"review process or watch development of future tutorials in our [Github " -"repo here](https://github.com/pyOpenSci/python-package-guide)." +"The first round of our community-developed, how to create a Python package " +"tutorial series for scientists is complete! Join our community review " +"process or watch development of future tutorials in our [Github repo " +"here](https://github.com/pyOpenSci/python-package-guide)." msgstr "" +"コミュニティが開発した、科学者のためのPythonパッケージの作り方チュートリアルシリーズの第一弾が完成しました！ " +"コミュニティのレビュープロセスに参加したり、 [Github " +"リポジトリはこちら](https://github.com/pyOpenSci/python-package-guide) " +"で今後のチュートリアルの開発を見守ったりしてください。" #: ../../index.md:71 msgid "✿ Create a Package Tutorials ✿" -msgstr "" +msgstr "✿ チュートリアルパッケージの作成 ✿" #: ../../index.md:75 msgid "[What is a Python package?](/tutorials/intro)" -msgstr "" +msgstr "[Pythonパッケージとは何か?](/tutorials/intro)" #: ../../index.md:76 msgid "[Make your code installable](/tutorials/installable-code)" -msgstr "" +msgstr "[コードをインストール可能にする](/tutorials/installable-code)" #: ../../index.md:77 msgid "[Publish your package to (test) PyPI](/tutorials/publish-pypi)" -msgstr "" +msgstr "[パッケージを(テスト用の)PyPIに公開する](/tutorials/publish-pypi)" #: ../../index.md:78 msgid "[Publish your package to conda-forge](/tutorials/publish-conda-forge)" -msgstr "" +msgstr "[パッケージを conda-forge に公開する](/tutorials/publish-conda-forge)" #: ../../index.md:83 msgid "✿ Package Metadata Tutorials ✿" -msgstr "" +msgstr "✿パッケージメタデータチュートリアル✿" #: ../../index.md:87 msgid "[How to add a README file](/tutorials/add-readme)" -msgstr "" +msgstr "[READMEファイルの追加方法](/tutorials/add-readme)" #: ../../index.md:88 msgid "" "[How to add metadata to a pyproject.toml file for publication to " "PyPI.](/tutorials/pyproject-toml.md)" msgstr "" +"[PyPIに公開するためにpyproject.tomlファイルにメタデータを追加する方法](/tutorials/pyproject-toml.md)" #: ../../index.md:93 msgid "✿ Packaging Tool Tutorials ✿" -msgstr "" +msgstr "✿パッケージングツールのチュートリアル✿" #: ../../index.md:97 msgid "[Introduction to Hatch](/tutorials/get-to-know-hatch)" -msgstr "" +msgstr "[Hatch入門](/tutorials/get-to-know-hatch)" #: ../../index.md:102 msgid "Python Packaging for Scientists" -msgstr "" +msgstr "科学者のためのPythonパッケージング" #: ../../index.md:104 msgid "" -"Learn about Python packaging best practices. You will also get to know " -"the the vibrant ecosystem of packaging tools that are available to help " -"you with your Python packaging needs." +"Learn about Python packaging best practices. You will also get to know the " +"the vibrant ecosystem of packaging tools that are available to help you with" +" your Python packaging needs." msgstr "" +"Python のパッケージングのベストプラクティスについて学びます。 また、Python " +"のパッケージングを支援するために利用可能なパッケージングツールの活発なエコシステムを知ることができます。" #: ../../index.md:113 msgid "✨ Create your package ✨" -msgstr "" +msgstr "✨パッケージの作成✨" #: ../../index.md:117 -msgid "[Package file structure](/package-structure-code/python-package-structure)" -msgstr "" +msgid "" +"[Package file structure](/package-structure-code/python-package-structure)" +msgstr "[パッケージファイル構造](/package-structure-code/python-package-structure)" #: ../../index.md:118 msgid "" -"[Package metadata / pyproject.toml](package-structure-code/pyproject-" -"toml-python-package-metadata.md)" +"[Package metadata / pyproject.toml](package-structure-code/pyproject-toml-" +"python-package-metadata.md)" msgstr "" +"[パッケージメタデータ / pyproject.toml](package-structure-code/pyproject-toml-python-" +"package-metadata.md)" #: ../../index.md:119 msgid "" -"[Build your package (sdist / wheel)](package-structure-code/python-" -"package-distribution-files-sdist-wheel.md)" +"[Build your package (sdist / wheel)](package-structure-code/python-package-" +"distribution-files-sdist-wheel.md)" msgstr "" +"[パッケージのビルド (sdist / wheel)](package-structure-code/python-package-" +"distribution-files-sdist-wheel.md)" #: ../../index.md:120 msgid "[Declare dependencies](package-structure-code/declare-dependencies.md)" -msgstr "" +msgstr "[依存関係の宣言](package-structure-code/declare-dependencies.md)" #: ../../index.md:121 msgid "" "[Navigate the packaging tool ecosystem](package-structure-code/python-" "package-build-tools.md)" msgstr "" +"[パッケージングツールのエコシステムをナビゲートする](package-structure-code/python-package-build-" +"tools.md)" #: ../../index.md:122 msgid "" "[Non pure Python builds](package-structure-code/complex-python-package-" "builds.md)" msgstr "" +"[純粋な Python 以外のビルド](package-structure-code/complex-python-package-builds.md)" #: ../../index.md:127 msgid "✨ Publish your package ✨" -msgstr "" +msgstr "✨パッケージを公開する✨" #: ../../index.md:131 msgid "" -"Gain a better understanding of the Python packaging ecosystem Learn about" -" best practices for:" -msgstr "" +"Gain a better understanding of the Python packaging ecosystem Learn about " +"best practices for:" +msgstr "Pythonのパッケージングエコシステムをより深く理解するためのベストプラクティスを学ぶ:" #: ../../index.md:134 msgid "" "[Package versioning & release](/package-structure-code/python-package-" "versions.md)" msgstr "" +"[パッケージのバージョン管理とリリース](/package-structure-code/python-package-versions.md)" #: ../../index.md:135 msgid "" "[Publish to PyPI & Conda-forge](/package-structure-code/publish-python-" "package-pypi-conda.md)" msgstr "" +"[PyPIとConda-forgeへの公開](/package-structure-code/publish-python-package-pypi-" +"conda.md)" #: ../../index.md:148 msgid "✨ Write The Docs ✨" -msgstr "" +msgstr "✨ドキュメントを書く✨" #: ../../index.md:151 msgid "" "[Create documentation for your users](/documentation/write-user-" "documentation/intro)" -msgstr "" +msgstr "[ユーザーのための文書を作成する](/documentation/write-user-documentation/intro)" #: ../../index.md:152 msgid "" -"[Core files to include in your package repository](/documentation" -"/repository-files/intro)" -msgstr "" +"[Core files to include in your package " +"repository](/documentation/repository-files/intro)" +msgstr "[パッケージリポジトリに含めるコアファイル](/documentation/repository-files/intro)" #: ../../index.md:153 msgid "" "[Write tutorials to show how your package is used](/documentation/write-" "user-documentation/create-package-tutorials)" msgstr "" +"[パッケージがどのように使われるかを示すチュートリアルを書く](/documentation/write-user-" +"documentation/create-package-tutorials)" #: ../../index.md:158 msgid "✨ Developer Docs ✨" -msgstr "" +msgstr "✨開発者向けドキュメント✨" #: ../../index.md:161 msgid "" -"[Create documentation for collaborating developers](/documentation" -"/repository-files/contributing-file)" +"[Create documentation for collaborating " +"developers](/documentation/repository-files/contributing-file)" msgstr "" +"[共同開発者のためのドキュメントの作成](/documentation/repository-files/contributing-file)" #: ../../index.md:162 msgid "" "[Write a development guide](/documentation/repository-files/development-" "guide)" -msgstr "" +msgstr "[開発ガイドを書く](/documentation/repository-files/development-guide)" #: ../../index.md:167 msgid "✨ Document For A Community ✨" -msgstr "" +msgstr "✨コミュニティのためのドキュメント✨" #: ../../index.md:170 msgid "" "[Writing a README file](/documentation/repository-files/readme-file-best-" "practices)" msgstr "" +"[READMEファイルの書き方](/documentation/repository-files/readme-file-best-practices)" #: ../../index.md:171 msgid "" -"[Set norms with a Code of Conduct](/documentation/repository-files/code-" -"of-conduct-file)" -msgstr "" +"[Set norms with a Code of Conduct](/documentation/repository-files/code-of-" +"conduct-file)" +msgstr "[行動規範で規範を定める](/documentation/repository-files/code-of-conduct-file)" #: ../../index.md:172 msgid "[License your package](/documentation/repository-files/license-files)" -msgstr "" +msgstr "[パッケージのライセンス](/documentation/repository-files/license-files)" #: ../../index.md:177 msgid "✨ Publish Your Docs ✨" -msgstr "" +msgstr "✨ドキュメントを公開する✨" #: ../../index.md:180 msgid "[How to publish your docs](/documentation/hosting-tools/intro)" -msgstr "" +msgstr "[ドキュメントを公開する方法](/documentation/hosting-tools/intro)" #: ../../index.md:181 msgid "[Using Sphinx](/documentation/hosting-tools/intro)" -msgstr "" +msgstr "[Sphinxを使う](/documentation/hosting-tools/intro)" #: ../../index.md:182 msgid "" -"[Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-" -"rst-doc-syntax)" +"[Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-" +"doc-syntax)" msgstr "" +"[Markdown、MyST、およびReST](/documentation/hosting-tools/myst-markdown-rst-doc-" +"syntax)" #: ../../index.md:183 msgid "" "[Host your docs on Read The Docs or Github Pages](/documentation/hosting-" "tools/publish-documentation-online)" msgstr "" +"[Read The Docs または Github Pages でドキュメントをホストする](/documentation/hosting-" +"tools/publish-documentation-online)" #: ../../index.md:189 msgid "" "*We are actively working on this section. [Follow development " "here.](https://github.com/pyOpenSci/python-package-guide)*" msgstr "" +"*私たちはこのセクションに積極的に取り組んでいます。 " +"[開発のフォローはこちら](https://github.com/pyOpenSci/python-package-guide)*" #: ../../index.md:197 msgid "✨ Tests for your Python package ✨" -msgstr "" +msgstr "✨Pythonパッケージのテスト✨" #: ../../index.md:200 msgid "[Intro to testing](tests/index.md)" -msgstr "" +msgstr "[テスト入門](tests/index.md)" #: ../../index.md:201 msgid "[Write tests](tests/write-tests)" -msgstr "" +msgstr "[テストを書く](tests/write-tests)" #: ../../index.md:202 msgid "[Types of tests](tests/test-types)" -msgstr "" +msgstr "[テストの種類](tests/test-types)" #: ../../index.md:207 msgid "✨ Run your tests ✨" -msgstr "" +msgstr "✨テストの実行✨" #: ../../index.md:210 msgid "[Run tests locally](tests/run-tests)" -msgstr "" +msgstr "[ローカルでテストを実行する](tests/run-tests)" #: ../../index.md:211 msgid "[Run tests in CI](tests/tests-ci)" -msgstr "" +msgstr "[CIでテストを実行する](tests/tests-ci)" #: ../../index.md:215 msgid "Contributing" -msgstr "" +msgstr "貢献" #: ../../index.md:225 msgid "✨ Code style & Format ✨" -msgstr "" +msgstr "✨コードスタイルとフォーマット✨" #: ../../index.md:230 msgid "[Code style](package-structure-code/code-style-linting-format.md)" -msgstr "" +msgstr "[コードスタイル](package-structure-code/code-style-linting-format.md)" #: ../../index.md:235 msgid "✨ Want to contribute? ✨" -msgstr "" +msgstr "✨貢献したいですか？ ✨" #: ../../index.md:240 msgid "" "We welcome contributions to this guide. Learn more about how you can " "contribute." -msgstr "" +msgstr "このガイドへのご貢献をお待ちしております。貢献方法についてはこちらをご覧ください。" #: ../../index.md:246 msgid "" -"xkcd comic showing a stick figure on the ground and one in the air. The " -"one on the ground is saying. `You're flying! how?` The person in the air" -" replies `Python!` Below is a 3 rectangle comic with the following text " -"in each box. box 1 - I learned it last night. Everything is so simple. " -"Hello world is just print hello world. box 2 - the person on the ground " -"says - come join us programming is fun again. it's a whole new world. But" -" how are you flying? box 3 - the person flying says - i just typed import" -" antigravity. I also sampled everything in the medicine cabinet. But i " -"think this is the python. the person on the ground is saying - that's it?" -msgstr "" +"xkcd comic showing a stick figure on the ground and one in the air. The one " +"on the ground is saying. `You're flying! how?` The person in the air " +"replies `Python!` Below is a 3 rectangle comic with the following text in " +"each box. box 1 - I learned it last night. Everything is so simple. Hello " +"world is just print hello world. box 2 - the person on the ground says - " +"come join us programming is fun again. it's a whole new world. But how are " +"you flying? box 3 - the person flying says - i just typed import " +"antigravity. I also sampled everything in the medicine cabinet. But i think " +"this is the python. the person on the ground is saying - that's it?" +msgstr "" +"xkcdの漫画で、地面に置かれた棒人間と空中にある棒人間が描かれている。地上にいる人が言っている。 `あなたは飛んでいる！どうやって？` 空中にいる人は" +" `Python!` と答える。以下は3つの長方形のマンガで、各ボックスに次のテキストが入っている。ボックス1 - " +"昨夜学んだ。すべてがとてもシンプルだ。Hello worldはprint hello worldだけ。ボックス2 - " +"地上にいる人が言う。まったく新しい世界だ。でもどうやって飛んでるの？ボックス3 - 飛んでいる人はこう言う。- " +"`反重力をインポートしました。薬箱の中のものも全部試しました。でもこれがpythonだと思う。地上の人はこう言っている。- これで終わり？" #: ../../index.md:252 msgid "A community-created guidebook" -msgstr "" +msgstr "コミュニティが作るガイドブック" #: ../../index.md:254 msgid "" "Every page in this guidebook goes through an extensive community review " -"process. To ensure our guidebook is both beginner-friendly and accurate, " -"we encourage reviews from a diverse set of pythonistas and scientists " -"with a wide range of skills and expertise." +"process. To ensure our guidebook is both beginner-friendly and accurate, we " +"encourage reviews from a diverse set of pythonistas and scientists with a " +"wide range of skills and expertise." msgstr "" +"このガイドブックのすべてのページは、コミュニティの広範なレビュープロセスを経ています。 " +"このガイドブックが初心者にやさしく、正確であることを保証するために、私たちは幅広いスキルと専門知識を持つ多様なpythonistaや科学者からのレビューを奨励しています。" #: ../../index.md:257 msgid "View guidebook contributors" -msgstr "" +msgstr "ガイドブックの貢献者を見る" #: ../../index.md:265 msgid "Who this guidebook is for" -msgstr "" +msgstr "このガイドブックの対象者" #: ../../index.md:267 msgid "" "This guidebook is for anyone interested in learning more about Python " "packaging. It is beginner-friendly and will provide:" -msgstr "" +msgstr "このガイドブックはPythonのパッケージングについてもっと学びたいと思っている人のためのものです。 初心者に優しく、以下を提供します:" #: ../../index.md:269 msgid "Beginning-to-end guidance on creating a Python package." -msgstr "" +msgstr "Pythonパッケージの作成に関する初歩から終わりまでのガイダンス。" #: ../../index.md:270 msgid "" -"Resources to help you navigate the Python packaging ecosystem of tools " -"and approaches to packaging." -msgstr "" +"Resources to help you navigate the Python packaging ecosystem of tools and " +"approaches to packaging." +msgstr "Python のパッケージングエコシステムをナビゲートするのに役立つリソースです。" #: ../../index.md:271 msgid "" -"A curated list of resources to help you get your package into documented," -" usable and maintainable shape." -msgstr "" +"A curated list of resources to help you get your package into documented, " +"usable and maintainable shape." +msgstr "あなたのパッケージが文書化され、使用可能で保守可能な形になるのを助けるリソースの厳選されたリストです。" #: ../../index.md:273 msgid "Where this guide is headed" -msgstr "" +msgstr "このガイドの方向性" #: ../../index.md:275 msgid "" -"If you have ideas of things you'd like to see here clarified in this " -"guide, [we invite you to open an issue on " +"If you have ideas of things you'd like to see here clarified in this guide, " +"[we invite you to open an issue on " "GitHub.](https://github.com/pyOpenSci/python-package-guide/issues)." msgstr "" +"このガイドで明確にしてほしいことがあれば、 " +"[GitHubにissueを開いてください。](https://github.com/pyOpenSci/python-package-" +"guide/issues) 。" #: ../../index.md:278 msgid "" -"If you have questions about our peer review process or packaging in " -"general, you are welcome to use our [pyOpenSci Discourse " +"If you have questions about our peer review process or packaging in general," +" you are welcome to use our [pyOpenSci Discourse " "forum](https://pyopensci.discourse.group/)." msgstr "" +"レビュープロセスやパッケージング全般について質問がある場合は、 [pyOpenSci Discourse " +"forum](https://pyopensci.discourse.group/) をご利用ください。" #: ../../index.md:280 msgid "" -"This is a living guide that is updated as tools and best practices evolve" -" in the Python packaging ecosystem. We will be adding new content over " -"the next year." +"This is a living guide that is updated as tools and best practices evolve in" +" the Python packaging ecosystem. We will be adding new content over the next" +" year." msgstr "" +"これは Python のパッケージングエコシステムにおけるツールやベストプラクティスの進化に合わせて更新される生きたガイドです。 " +"来年にかけて新しいコンテンツを追加していく予定です。" From a2d871b46eacfeb4b2ca8d37915ff1be2afb405f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 11 Aug 2024 06:23:53 +0000 Subject: [PATCH 11/38] =?UTF-8?q?'[pre-commit.ci=20=F0=9F=A4=96]=20Apply?= =?UTF-8?q?=20code=20format=20tools=20to=20PR'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- locales/ja/LC_MESSAGES/index.po | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/locales/ja/LC_MESSAGES/index.po b/locales/ja/LC_MESSAGES/index.po index 50c7a478..399d1cb1 100644 --- a/locales/ja/LC_MESSAGES/index.po +++ b/locales/ja/LC_MESSAGES/index.po @@ -3,10 +3,10 @@ # This file is distributed under the same license as the pyOpenSci Python # Package Guide package. # FIRST AUTHOR , 2024. -# +# # Translators: # Tetsuo Koyama , 2024 -# +# #, fuzzy msgid "" msgstr "" From bd330b85990a04b71ad4e6df5d6e9ae59e400ed0 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Sun, 11 Aug 2024 15:30:06 +0900 Subject: [PATCH 12/38] Revert msgid part --- locales/ja/LC_MESSAGES/index.po | 123 +++++++++++++++----------------- 1 file changed, 59 insertions(+), 64 deletions(-) diff --git a/locales/ja/LC_MESSAGES/index.po b/locales/ja/LC_MESSAGES/index.po index 399d1cb1..83e4bdda 100644 --- a/locales/ja/LC_MESSAGES/index.po +++ b/locales/ja/LC_MESSAGES/index.po @@ -4,24 +4,21 @@ # Package Guide package. # FIRST AUTHOR , 2024. # -# Translators: -# Tetsuo Koyama , 2024 -# #, fuzzy msgid "" msgstr "" -"Project-Id-Version: pyOpenSci Python Package Guide\n" +"Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-08-02 18:04+0900\n" -"PO-Revision-Date: 2024-08-07 23:17+0000\n" -"Last-Translator: Tetsuo Koyama , 2024\n" -"Language-Team: Japanese (https://app.transifex.com/tkoyama010/teams/196662/ja/)\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: ja\n" +"Language-Team: ja \n" +"Plural-Forms: nplurals=1; plural=0;\n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" +"Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.15.0\n" -"Language: ja\n" -"Plural-Forms: nplurals=1; plural=0;\n" #: ../../index.md:283 msgid "Tutorials" @@ -84,12 +81,12 @@ msgstr "このガイドについて" #: ../../index.md:29 msgid "" "Image with the pyOpenSci flower logo in the upper right hand corner. The " -"image shows the packaging lifecycle. The graphic shows a high level overview" -" of the elements of a Python package. the inside circle has 5 items - user " -"documentation, code/api, test suite, contributor documentation, project " -"metadata / license / readme. In the middle of the circle is says maintainers" -" and has a small icon with people. on the outside circle there is an arrow " -"and it says infrastructure." +"image shows the packaging lifecycle. The graphic shows a high level " +"overview of the elements of a Python package. the inside circle has 5 " +"items - user documentation, code/api, test suite, contributor " +"documentation, project metadata / license / readme. In the middle of the " +"circle is says maintainers and has a small icon with people. on the " +"outside circle there is an arrow and it says infrastructure." msgstr "" "右上にpyOpenSciの花のロゴがある画像。画像はパッケージングのライフサイクルを示しています。図にはPythonパッケージの要素のハイレベルな概要が示されています。内側の円には5つの項目があります" " - " @@ -112,8 +109,7 @@ msgid "Navigate and make decisions around tool options" msgstr "ツールオプションのナビゲートと決定" #: ../../index.md:40 -msgid "" -"Understand all of the pieces of creating and maintaining a Python package" +msgid "Understand all of the pieces of creating and maintaining a Python package" msgstr "Pythonパッケージの作成と保守のすべてを理解する" #: ../../index.md:42 @@ -161,10 +157,10 @@ msgstr "_new_ チュートリアルシリーズ: Pythonパッケージの作成" #: ../../index.md:61 msgid "" -"The first round of our community-developed, how to create a Python package " -"tutorial series for scientists is complete! Join our community review " -"process or watch development of future tutorials in our [Github repo " -"here](https://github.com/pyOpenSci/python-package-guide)." +"The first round of our community-developed, how to create a Python " +"package tutorial series for scientists is complete! Join our community " +"review process or watch development of future tutorials in our [Github " +"repo here](https://github.com/pyOpenSci/python-package-guide)." msgstr "" "コミュニティが開発した、科学者のためのPythonパッケージの作り方チュートリアルシリーズの第一弾が完成しました！ " "コミュニティのレビュープロセスに参加したり、 [Github " @@ -220,9 +216,9 @@ msgstr "科学者のためのPythonパッケージング" #: ../../index.md:104 msgid "" -"Learn about Python packaging best practices. You will also get to know the " -"the vibrant ecosystem of packaging tools that are available to help you with" -" your Python packaging needs." +"Learn about Python packaging best practices. You will also get to know " +"the the vibrant ecosystem of packaging tools that are available to help " +"you with your Python packaging needs." msgstr "" "Python のパッケージングのベストプラクティスについて学びます。 また、Python " "のパッケージングを支援するために利用可能なパッケージングツールの活発なエコシステムを知ることができます。" @@ -232,22 +228,21 @@ msgid "✨ Create your package ✨" msgstr "✨パッケージの作成✨" #: ../../index.md:117 -msgid "" -"[Package file structure](/package-structure-code/python-package-structure)" +msgid "[Package file structure](/package-structure-code/python-package-structure)" msgstr "[パッケージファイル構造](/package-structure-code/python-package-structure)" #: ../../index.md:118 msgid "" -"[Package metadata / pyproject.toml](package-structure-code/pyproject-toml-" -"python-package-metadata.md)" +"[Package metadata / pyproject.toml](package-structure-code/pyproject-" +"toml-python-package-metadata.md)" msgstr "" "[パッケージメタデータ / pyproject.toml](package-structure-code/pyproject-toml-python-" "package-metadata.md)" #: ../../index.md:119 msgid "" -"[Build your package (sdist / wheel)](package-structure-code/python-package-" -"distribution-files-sdist-wheel.md)" +"[Build your package (sdist / wheel)](package-structure-code/python-" +"package-distribution-files-sdist-wheel.md)" msgstr "" "[パッケージのビルド (sdist / wheel)](package-structure-code/python-package-" "distribution-files-sdist-wheel.md)" @@ -277,8 +272,8 @@ msgstr "✨パッケージを公開する✨" #: ../../index.md:131 msgid "" -"Gain a better understanding of the Python packaging ecosystem Learn about " -"best practices for:" +"Gain a better understanding of the Python packaging ecosystem Learn about" +" best practices for:" msgstr "Pythonのパッケージングエコシステムをより深く理解するためのベストプラクティスを学ぶ:" #: ../../index.md:134 @@ -308,8 +303,8 @@ msgstr "[ユーザーのための文書を作成する](/documentation/write-use #: ../../index.md:152 msgid "" -"[Core files to include in your package " -"repository](/documentation/repository-files/intro)" +"[Core files to include in your package repository](/documentation" +"/repository-files/intro)" msgstr "[パッケージリポジトリに含めるコアファイル](/documentation/repository-files/intro)" #: ../../index.md:153 @@ -326,8 +321,8 @@ msgstr "✨開発者向けドキュメント✨" #: ../../index.md:161 msgid "" -"[Create documentation for collaborating " -"developers](/documentation/repository-files/contributing-file)" +"[Create documentation for collaborating developers](/documentation" +"/repository-files/contributing-file)" msgstr "" "[共同開発者のためのドキュメントの作成](/documentation/repository-files/contributing-file)" @@ -350,8 +345,8 @@ msgstr "" #: ../../index.md:171 msgid "" -"[Set norms with a Code of Conduct](/documentation/repository-files/code-of-" -"conduct-file)" +"[Set norms with a Code of Conduct](/documentation/repository-files/code-" +"of-conduct-file)" msgstr "[行動規範で規範を定める](/documentation/repository-files/code-of-conduct-file)" #: ../../index.md:172 @@ -372,8 +367,8 @@ msgstr "[Sphinxを使う](/documentation/hosting-tools/intro)" #: ../../index.md:182 msgid "" -"[Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-" -"doc-syntax)" +"[Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-" +"rst-doc-syntax)" msgstr "" "[Markdown、MyST、およびReST](/documentation/hosting-tools/myst-markdown-rst-doc-" "syntax)" @@ -446,15 +441,15 @@ msgstr "このガイドへのご貢献をお待ちしております。貢献方 #: ../../index.md:246 msgid "" -"xkcd comic showing a stick figure on the ground and one in the air. The one " -"on the ground is saying. `You're flying! how?` The person in the air " -"replies `Python!` Below is a 3 rectangle comic with the following text in " -"each box. box 1 - I learned it last night. Everything is so simple. Hello " -"world is just print hello world. box 2 - the person on the ground says - " -"come join us programming is fun again. it's a whole new world. But how are " -"you flying? box 3 - the person flying says - i just typed import " -"antigravity. I also sampled everything in the medicine cabinet. But i think " -"this is the python. the person on the ground is saying - that's it?" +"xkcd comic showing a stick figure on the ground and one in the air. The " +"one on the ground is saying. `You're flying! how?` The person in the air" +" replies `Python!` Below is a 3 rectangle comic with the following text " +"in each box. box 1 - I learned it last night. Everything is so simple. " +"Hello world is just print hello world. box 2 - the person on the ground " +"says - come join us programming is fun again. it's a whole new world. But" +" how are you flying? box 3 - the person flying says - i just typed import" +" antigravity. I also sampled everything in the medicine cabinet. But i " +"think this is the python. the person on the ground is saying - that's it?" msgstr "" "xkcdの漫画で、地面に置かれた棒人間と空中にある棒人間が描かれている。地上にいる人が言っている。 `あなたは飛んでいる！どうやって？` 空中にいる人は" " `Python!` と答える。以下は3つの長方形のマンガで、各ボックスに次のテキストが入っている。ボックス1 - " @@ -469,9 +464,9 @@ msgstr "コミュニティが作るガイドブック" #: ../../index.md:254 msgid "" "Every page in this guidebook goes through an extensive community review " -"process. To ensure our guidebook is both beginner-friendly and accurate, we " -"encourage reviews from a diverse set of pythonistas and scientists with a " -"wide range of skills and expertise." +"process. To ensure our guidebook is both beginner-friendly and accurate, " +"we encourage reviews from a diverse set of pythonistas and scientists " +"with a wide range of skills and expertise." msgstr "" "このガイドブックのすべてのページは、コミュニティの広範なレビュープロセスを経ています。 " "このガイドブックが初心者にやさしく、正確であることを保証するために、私たちは幅広いスキルと専門知識を持つ多様なpythonistaや科学者からのレビューを奨励しています。" @@ -496,14 +491,14 @@ msgstr "Pythonパッケージの作成に関する初歩から終わりまでの #: ../../index.md:270 msgid "" -"Resources to help you navigate the Python packaging ecosystem of tools and " -"approaches to packaging." +"Resources to help you navigate the Python packaging ecosystem of tools " +"and approaches to packaging." msgstr "Python のパッケージングエコシステムをナビゲートするのに役立つリソースです。" #: ../../index.md:271 msgid "" -"A curated list of resources to help you get your package into documented, " -"usable and maintainable shape." +"A curated list of resources to help you get your package into documented," +" usable and maintainable shape." msgstr "あなたのパッケージが文書化され、使用可能で保守可能な形になるのを助けるリソースの厳選されたリストです。" #: ../../index.md:273 @@ -512,8 +507,8 @@ msgstr "このガイドの方向性" #: ../../index.md:275 msgid "" -"If you have ideas of things you'd like to see here clarified in this guide, " -"[we invite you to open an issue on " +"If you have ideas of things you'd like to see here clarified in this " +"guide, [we invite you to open an issue on " "GitHub.](https://github.com/pyOpenSci/python-package-guide/issues)." msgstr "" "このガイドで明確にしてほしいことがあれば、 " @@ -522,8 +517,8 @@ msgstr "" #: ../../index.md:278 msgid "" -"If you have questions about our peer review process or packaging in general," -" you are welcome to use our [pyOpenSci Discourse " +"If you have questions about our peer review process or packaging in " +"general, you are welcome to use our [pyOpenSci Discourse " "forum](https://pyopensci.discourse.group/)." msgstr "" "レビュープロセスやパッケージング全般について質問がある場合は、 [pyOpenSci Discourse " @@ -531,9 +526,9 @@ msgstr "" #: ../../index.md:280 msgid "" -"This is a living guide that is updated as tools and best practices evolve in" -" the Python packaging ecosystem. We will be adding new content over the next" -" year." +"This is a living guide that is updated as tools and best practices evolve" +" in the Python packaging ecosystem. We will be adding new content over " +"the next year." msgstr "" "これは Python のパッケージングエコシステムにおけるツールやベストプラクティスの進化に合わせて更新される生きたガイドです。 " "来年にかけて新しいコンテンツを追加していく予定です。" From 24fa2dd2bcf930a51f85fea790bd9f4d11c7eade Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Tue, 13 Aug 2024 09:08:10 +0900 Subject: [PATCH 13/38] Remove conjunctions in bullet points --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9fec35f9..5b209387 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ pyOpenSci is devoted to building diverse, supportive community around the Python open source tools that drive open science. We do this through: * open peer review -* mentorship and -* training. +* mentorshipd +* training pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives. From 62c7824ef132eb4b1b57eee1b0626fa403cfc3f4 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Tue, 13 Aug 2024 09:24:29 +0900 Subject: [PATCH 14/38] Apply suggestions from code review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b209387..fba12c89 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ pyOpenSci is devoted to building diverse, supportive community around the Python open source tools that drive open science. We do this through: * open peer review -* mentorshipd +* mentorship * training pyOpenSci is an independent organization, fiscally sponsored by Community From ba2cc267e3b4e9b3cbc52eb47b3e461567f56d95 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Thu, 15 Aug 2024 20:37:22 +0000 Subject: [PATCH 15/38] docs: update README.md [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 077415ba..76cf0015 100644 --- a/README.md +++ b/README.md @@ -167,7 +167,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Naty Clementi
Naty Clementi
💻 👀 John Drake
John Drake
💻 👀 Revathy Venugopal
Revathy Venugopal
💻 👀 📖 - Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 + Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍 Carol Willing
Carol Willing
👀 Kozo Nishida
Kozo Nishida
👀 🌍 From f0f09159c0cc071c93feecb47dbf524c761761f5 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Thu, 15 Aug 2024 20:37:23 +0000 Subject: [PATCH 16/38] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 02130453..5df4d977 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -762,7 +762,8 @@ "contributions": [ "code", "review", - "doc" + "doc", + "translation" ] }, { From 399f373e232ad1885664b74c2e013501be0f8a5f Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 16 Aug 2024 09:26:16 +0900 Subject: [PATCH 17/38] docs: add star-history to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 077415ba..9341d076 100644 --- a/README.md +++ b/README.md @@ -180,3 +180,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=pyOpenSci/python-package-guide&type=Date)](https://star-history.com/#pyOpenSci/python-package-guide&Date) From dfee22e7d9f99c83b79804b68dae911a6921758a Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Sat, 17 Aug 2024 19:28:55 +0200 Subject: [PATCH 18/38] Update website-hosting-optimizing-your-docs.md with correct anchor --- .../hosting-tools/website-hosting-optimizing-your-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/hosting-tools/website-hosting-optimizing-your-docs.md b/documentation/hosting-tools/website-hosting-optimizing-your-docs.md index c9a57907..0e6f7f60 100644 --- a/documentation/hosting-tools/website-hosting-optimizing-your-docs.md +++ b/documentation/hosting-tools/website-hosting-optimizing-your-docs.md @@ -41,7 +41,7 @@ It [requires that you to add it to your Sphinx `conf.py` extension list and site OpenGraph is an extension that allows you to add metadata to your documentation content pages. [The OpenGraph protocol allows other websites to provide a -useful preview of the content on your page when shared](https://www.freecodecamp.org/news/what-is-open-graph-and-how-can-i-use-it-for-my-website/#what-is-open-graph). This is important +useful preview of the content on your page when shared](https://www.freecodecamp.org/news/what-is-open-graph-and-how-can-i-use-it-for-my-website/#heading-what-is-open-graph). This is important for when the pages in your documentation are shared on social media sites like Twitter and Mastodon and even for shares on tools like Slack and Discourse. From 031b9a74a8badefa43a578d664b495edf38abbfa Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Sun, 18 Aug 2024 14:53:30 +0900 Subject: [PATCH 19/38] Fix typos GitHub action -> GitHub Actions --- TRANSLATING.md | 2 +- package-structure-code/python-package-versions.md | 2 +- tests/index.md | 2 +- tests/tests-ci.md | 4 ++-- tests/write-tests.md | 2 +- tutorials/publish-pypi.md | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 9fb5e5b2..710b842d 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -265,7 +265,7 @@ When you submit a PR for a translation, you should only include changes to one l Translations PRs will be tagged with a label indicating the language to make them easier to identify and review. For example, contributions to the Spanish translation will be tagged with 'lang-es'. -TODO: This tagging could be automated with a GitHub action. +TODO: This tagging could be automated with a GitHub Actions. When you submit the PR, make sure to include a short description of the changes you made and any context that might be helpful for the reviewer (e.g., you translated new strings, you reviewed fuzzy entries, you fixed typos, etc.) diff --git a/package-structure-code/python-package-versions.md b/package-structure-code/python-package-versions.md index 27a4e1d9..39c8f229 100644 --- a/package-structure-code/python-package-versions.md +++ b/package-structure-code/python-package-versions.md @@ -105,7 +105,7 @@ package versions: ### Semantic release, vs version control based vs manual version bumping Generally semantic release and version control system tools -can be setup to run automatically on GitHub using GitHub actions. +can be setup to run automatically on GitHub using GitHub Actions. This means that you can create a workflow where a GitHub release and associated new version tag is used to trigger an automated build that: diff --git a/tests/index.md b/tests/index.md index 8eaa2d6f..05ff0eee 100644 --- a/tests/index.md +++ b/tests/index.md @@ -53,7 +53,7 @@ of Python, then using an automation tool such as nox to run your tests is useful :link-type: doc :class-card: left-aligned -Continuous integration platforms such as GitHub actions can be +Continuous integration platforms such as GitHub Actions can be useful for running your tests across both different Python versions and different operating systems. Learn about setting up tests to run in Continuous Integration here. ::: diff --git a/tests/tests-ci.md b/tests/tests-ci.md index 45b184ba..417c922a 100644 --- a/tests/tests-ci.md +++ b/tests/tests-ci.md @@ -19,9 +19,9 @@ It allows users to contribute code, documentation fixes and more without having to create development environments, run tests and build documentation locally. -## Example GitHub action that runs tests +## Example GitHub Actions that runs tests -Below is an example GitHub action that runs tests using nox +Below is an example GitHub Actions that runs tests using nox across both Windows, Mac and Linux and on Python versions 3.9-3.11. diff --git a/tests/write-tests.md b/tests/write-tests.md index 5a96c040..56d2bbb1 100644 --- a/tests/write-tests.md +++ b/tests/write-tests.md @@ -18,7 +18,7 @@ Writing tests for your Python package is important because: - **Fearless Refactoring:** Refactoring means making improvements to your code structure without changing its behavior. Tests empower you to make these changes as if you break something, test failures will let you know. - **Documentation:** Tests serve as technical examples of how to use your package. This can be helpful for a new technical contributor that wants to contribute code to your package. They can look at your tests to understand how parts of your code functionality fits together. - **Long-Term ease of maintenance:** As your package evolves, tests ensure that your code continues to behave as expected, even as you make changes over time. Thus you are helping your future self when writing tests. -- **Easier pull request reviews:** By running your tests in a CI framework such as GitHub actions, each time you or a contributor makes a change to your code-base, you can catch issues and things that may have changed in your code base. This ensures that your software behaves the way you expect it to. +- **Easier pull request reviews:** By running your tests in a CI framework such as GitHub Actions, each time you or a contributor makes a change to your code-base, you can catch issues and things that may have changed in your code base. This ensures that your software behaves the way you expect it to. ### Tests for user edge cases diff --git a/tutorials/publish-pypi.md b/tutorials/publish-pypi.md index be800eb7..12da8265 100644 --- a/tutorials/publish-pypi.md +++ b/tutorials/publish-pypi.md @@ -58,7 +58,7 @@ to TestPyPI. You need to: 1. **Publish to TestPyPI using `hatch publish`** In a future lesson, you will learn how to create an automated -GitHub action workflow that publishes an updated +GitHub Actions workflow that publishes an updated version of your package to PyPI every time you create a GitHub release. :::{admonition} Learn more about building Python packages in our guide @@ -360,7 +360,7 @@ For long run maintenance of your package, you have two options related to PyPI publication. 1. You can create a package-specific token which you will use to publish your package (manually) to PyPI. This is a great option if you don't wish to automate your PyPI publication workflow. -2. You can also create an automated publication workflow on GitHub using GitHub actions. This is a great way to make the publication process easier and it also supports a growing maintainer team. In this case we suggest you don't worry about the token and instead setup a specific GitHub action that publishes your package when you make a release. You can then create a "trusted publisher" workflow on PyPI. +2. You can also create an automated publication workflow on GitHub using GitHub Actions. This is a great way to make the publication process easier and it also supports a growing maintainer team. In this case we suggest you don't worry about the token and instead setup a specific GitHub Actions that publishes your package when you make a release. You can then create a "trusted publisher" workflow on PyPI. You will learn how to create the automated trusted publisher workflow in a followup lesson. From 6023eb31131f6213219a250291a91e043bb9b85c Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 19 Aug 2024 07:42:26 +0200 Subject: [PATCH 20/38] Apply suggestions from code review Co-authored-by: Felipe Moreno --- .../es/LC_MESSAGES/package-structure-code.po | 70 +++++++++---------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/locales/es/LC_MESSAGES/package-structure-code.po b/locales/es/LC_MESSAGES/package-structure-code.po index f80e3cd6..0524dd36 100644 --- a/locales/es/LC_MESSAGES/package-structure-code.po +++ b/locales/es/LC_MESSAGES/package-structure-code.po @@ -3917,7 +3917,7 @@ msgid "" "your package on conda-forge. You do not need to rebuild your package to " "publish to conda-forge." msgstr "" -"Una vez que haya publicado ambas distribuciones de paquetes (la distribución de origen y la rueda) en PyPI, " +"Una vez que haya publicado ambas distribuciones de paquetes (la distribución del código fuente y la distribución construida o wheel) en PyPI, " "entonces puede publicar en conda-forge. conda-forge requiere una distribución de origen en PyPI para construir su " "paquete en conda-forge. No necesita reconstruir su paquete para publicar en conda-forge." @@ -3934,7 +3934,7 @@ msgstr "" "(o en un canal de conda). El proceso de construcción organiza su código " "y metadatos en un formato de distribución que puede ser subido a PyPI y " "posteriormente descargado e instalado por los usuarios. NOTA: necesita " -"publicar un sdist en PyPI para que conda-forge pueda construir su paquete " +"publicar un sdist (distribución del código fuente) en PyPI para que conda-forge pueda construir su paquete " "automáticamente." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:14 @@ -3951,7 +3951,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:18 msgid "But, what does it mean to build a Python package?" -msgstr "Per, ¿qué significa construir un paquete de Python?" +msgstr "Pero, ¿qué significa construir un paquete de Python?" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:20 msgid "" @@ -3964,7 +3964,7 @@ msgstr "" "[Como se muestra en la figura de arriba](#pypi-conda-channels), cuando construye su paquete de Python, convierte " "los archivos de código fuente en algo llamado paquete de distribución." " Un paquete de distribución contiene su código fuente " -"y metadatos sobre el paquete, en el formato requerido por el Índice de Paquetes de Python, para que pueda ser " +"y metadatos sobre el paquete, en el formato requerido por el Python Package Index (PyPI), para que pueda ser " "instalado por herramientas como pip." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:23 @@ -4020,7 +4020,7 @@ msgid "" "sdist and wheel distributions." msgstr "" "La tabla `[build-system]` en su archivo pyproject.toml le dice a pip qué [herramienta de backend de construcción]" -"(build_backends) desea usar para crear sus distribuciones sdist y wheel." +"(build_backends) desea usar para crear sus distribuciones sdist (distribución del código fuente) y wheel (distribución construida)." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:45 msgid "" @@ -4084,8 +4084,8 @@ msgstr "" "Gráfico que muestra el flujo de trabajo de empaquetado de alto nivel." " A la izquierda se ve un gráfico con código, metadatos y tests en él. " "Esos elementos van todos en su paquete. La documentación y los datos " -"están debajo de esa recuadro porque normalmente no se publican en su " -"distribución de rueda de empaquetado. Una flecha a la derecha lo lleva a " +"están debajo de ese recuadro porque normalmente no se publican en su " +"distribución construida (wheel). Una flecha a la derecha lo lleva a " "un cuadro de archivos de distribución de construcción. Ese cuadro lo lleva " "a publicar en TestPyPI o en el verdadero PyPI. Desde PyPI, puede conectarse " "a conda-forge para una construcción automatizada que envía distribuciones " @@ -4103,7 +4103,7 @@ msgstr "" "Necesita construir su paquete de Python para publicarlo en PyPI (o Conda). " "El proceso de construcción organiza su código y metadatos en un formato de " "distribución que puede ser subido a PyPI y posteriormente descargado e " -"instalado por los usuarios. NOTA: necesita publicar un sdist en PyPI para " +"instalado por los usuarios. NOTA: necesita publicar distribución del código fuente (sdist) en PyPI para " "que conda-forge pueda construir su paquete automáticamente." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:101 @@ -4142,7 +4142,7 @@ msgstr "" "Nombres de los mantenedores y nombres de usuario de GitHub para el paquete " "xclim tal como se muestran en PyPI. Esta información se registra en su " "pyproject.toml y luego es procesada por su herramienta de construcción y " -"almacenada en las distribuciones sdist y wheel (o rueda) de sus paquetes." +"almacenada en las distribuciones sdist y wheel de sus paquetes." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:115 msgid "How to create the distribution format that PyPI and Pip expects?" @@ -4158,8 +4158,8 @@ msgid "" msgstr "" "En teoría, podría crear sus propios scripts para organizar su código " "de la manera que PyPI quiere que sea. Sin embargo, al igual que hay " -"paquetes que manejan estructuras conocidas como Pandas para marcos " -"de datos y Numpy para matrices, hay paquetes y herramientas que le " +"paquetes que manejan estructuras conocidas como dataframes de Pandas " +"y arrays de Numpy, hay paquetes y herramientas que le " "ayudan a crear archivos de distribución de construcción de paquetes." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:121 @@ -4170,10 +4170,10 @@ msgid "" "your sdist and wheel. Whereas tools like Hatch, PDM, Poetry and flit help" " with other parts of the packaging process." msgstr "" -"Existen una serie de herramientas de empaquetado que pueden ayudarlo con " +"Existen una serie de herramientas de empaquetado que pueden ayudarle con " "todo el proceso de empaquetado o solo con un paso del proceso. Por ejemplo, " "setuptools es un backend de construcción comúnmente utilizado que se puede " -"usar para crear su sdist y wheel (o rueda). Mientras que herramientas como " +"usar para crear su sdist y wheel. Mientras que herramientas como " "Hatch, PDM, Poetry y flit ayudan con otras partes del proceso de empaquetado." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:127 @@ -4196,7 +4196,7 @@ msgid "" " what files belong in each." msgstr "" "A continuación, aprenderá sobre los dos archivos de distribución que PyPI " -"espera que publique: sdist y wheel (o rueda). Aprenderá sobre su estructura " +"espera que publique: sdist y wheel. Aprenderá sobre su estructura " "y qué archivos pertenecen a cada uno." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:136 @@ -4209,8 +4209,8 @@ msgid "" msgstr "" "Hay dos archivos de distribución principales que necesita crear para " "publicar su paquete de Python en PyPI: la distribución de origen (a menudo " -"llamada sdist) y la rueda (o wheel). El sdist contiene el código fuente " -"sin procesar de su paquete. La rueda (.whl) contiene los archivos " +"llamada sdist) y la distribución construida (wheel). El sdist contiene el código fuente " +"sin procesar de su paquete. La wheel (.whl) contiene los archivos " "construidos / compilados que se pueden instalar directamente en el " "ordenador de cualquier persona." @@ -4246,7 +4246,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:155 msgid "Source Distribution (sdist)" -msgstr "Distribución de origen (sdist)" +msgstr "Distribución de código fuente (sdist)" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:157 msgid "" @@ -4254,8 +4254,8 @@ msgid "" "These are the \"raw / as-is\" files that you store on GitHub or whatever " "platform you use to manage your code." msgstr "" -"Los **archivos de origen** son los archivos sin construir necesarios para " -"construir su paquete. Estos son los archivos \"crudos / tal como están\" " +"Los **archivos de código fuente** son los archivos sin construir necesarios para " +"construir su paquete. Estos son los archivos \"originales / sin procesar\" " "que almacena en GitHub o en cualquier plataforma que utilice para gestionar " "su código." @@ -4269,12 +4269,12 @@ msgid "" "everything required to build a wheel (except for project dependencies) " "without network access." msgstr "" -"Las distribuciones de origen (del inglés, _source distribution_) se denominan sdist. Como " -"su nombre indica, un SDIST contiene el código fuente; no ha sido construido ni" -" compilado de ninguna manera. Por lo tanto, cuando un usuario instala su distribución de origen " +"Las distribuciones de código fuente (del inglés, _source distribution_) se denominan sdist. Como " +"su nombre indica, una distribución sdist contiene el código fuente; no ha sido construido ni" +" compilado de ninguna manera. Por lo tanto, cuando un usuario instala su distribución de código fuente " "usando pip, pip necesita ejecutar un paso de construcción primero. Por esta razón, " -"podría definir una distribución de origen como un archivo comprimido que contiene todo lo " -"necesario para construir una rueda (excepto las dependencias del proyecto) sin acceso a la red." +"podría definir una distribución sdist como un archivo comprimido que contiene todo lo " +"necesario para construir una wheel (excepto las dependencias del proyecto) sin acceso a la red." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:165 msgid "" @@ -4312,7 +4312,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:229 msgid "Wheel (.whl files):" -msgstr "Rueda o _wheel_(.whl files):" +msgstr "Wheel (ficheros .whl):" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:231 msgid "" @@ -4323,13 +4323,13 @@ msgid "" "may be included in source distributions are not included in wheels " "because it is a built distribution." msgstr "" -"Un archivo de rueda es un archivo en formato ZIP cuyo nombre sigue" +"Un archivo wheel es un archivo en formato ZIP cuyo nombre sigue" " un formato específico (a continuación) y tiene la " "extensión `.whl`. El archivo `.whl` contiene un conjunto específico de " "archivos, incluidos metadatos que se generan a partir del archivo " "pyproject.toml de su proyecto. El pyproject.toml y otros archivos que " "pueden estar incluidos en las distribuciones de origen no se incluyen en " -"las ruedas porque es una distribución construida." +"las wheels porque es una distribución construida." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:238 msgid "" @@ -4341,13 +4341,13 @@ msgid "" "thus faster to install - particularly if you have a package that requires" " build steps." msgstr "" -"La rueda (.whl) es su distribución binaria construida. Los" +"La wheel (.whl) es su distribución binaria construida. Los" " **archivos binarios** son los archivos de código fuente " "construidos / compilados. Estos archivos están listos para ser instalados." -" Una rueda (**.whl**) es un archivo **zip** que contiene todos los archivos " +" Una wheel (**.whl**) es un archivo **zip** que contiene todos los archivos " "necesarios para instalar directamente su paquete. Todos los archivos en una " -"rueda son binarios, lo que significa que el código ya está compilado / " -"construido. Por lo tanto, las ruedas son más rápidas de instalar, " +"wheel son binarios, lo que significa que el código ya está compilado / " +"construido. Por lo tanto, estas son más rápidas de instalar, " "particularmente si tiene un paquete que requiere pasos de construcción." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:240 @@ -4356,7 +4356,7 @@ msgid "" " as **setup.cfg** or **pyproject.toml**. This distribution is already " "built so it's ready to install." msgstr "" -"La rueda no contiene ninguno de los archivos de configuración de su paquete " +"La wheel no contiene ninguno de los archivos de configuración de su paquete " "como **setup.cfg** o **pyproject.toml**. Esta distribución ya está construida " "por lo que está lista para instalar." @@ -4375,15 +4375,15 @@ msgid "" "the wheel bundle are pre built, the user installing doesn't have to worry" " about malicious code injections when it is installed." msgstr "" -"Las ruedas también son útiles en el caso de que un paquete necesite un " +"Las wheels también son útiles en el caso de que un paquete necesite un " "archivo **setup.py** para admitir una construcción más compleja. En este " -"caso, debido a que los archivos en el paquete de rueda están preconstruidos, " +"caso, debido a que los archivos en el paquete de wheel están preconstruidos, " "el usuario que lo instala no tiene que preocuparse por inyecciones de código " "malicioso cuando se instala." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:259 msgid "The filename of a wheel contains important metadata about your package." -msgstr "El nombre de archivo de una rueda contiene metadatos importantes sobre su paquete." +msgstr "El nombre de archivo de una wheel contiene metadatos importantes sobre su paquete." #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:261 msgid "Example: **stravalib-1.1.0.post2-py3-none.whl**" From f955a02bd2b65cf8c2b65791931b56848728b827 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 19 Aug 2024 07:44:46 +0200 Subject: [PATCH 21/38] fix: modify original file --- .../python-package-distribution-files-sdist-wheel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-structure-code/python-package-distribution-files-sdist-wheel.md b/package-structure-code/python-package-distribution-files-sdist-wheel.md index e8d6a99c..3253ed1b 100644 --- a/package-structure-code/python-package-distribution-files-sdist-wheel.md +++ b/package-structure-code/python-package-distribution-files-sdist-wheel.md @@ -107,7 +107,7 @@ PyPI screenshot showing metadata for the xclim package. :::{figure-md} pypi-metadata-maintainers -Here you see the maintinaer metadata as it is displayed on PyPI. for xclim there are three maintainers listed with their profile pictures and github user names to the right. +Here you see the maintainer metadata as it is displayed on PyPI. for xclim there are three maintainers listed with their profile pictures and github user names to the right. Maintainer names and GitHub usernames for the xclim package as they are displayed on PyPI. This information is recorded in your pyproject.toml and then processed by your build tool and stored in your packages sdist and wheel distributions. ::: From 5d24bb97abc7979b704aa5e8bcd0b7a7859b75da Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Mon, 19 Aug 2024 07:45:18 +0200 Subject: [PATCH 22/38] fix: modify translated file --- locales/es/LC_MESSAGES/package-structure-code.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/package-structure-code.po b/locales/es/LC_MESSAGES/package-structure-code.po index 0524dd36..45755258 100644 --- a/locales/es/LC_MESSAGES/package-structure-code.po +++ b/locales/es/LC_MESSAGES/package-structure-code.po @@ -4124,7 +4124,7 @@ msgstr "Captura de pantalla de PyPI que muestra metadatos para el paquete xclim. #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:110 msgid "" -"Here you see the maintinaer metadata as it is displayed on PyPI. for " +"Here you see the maintainer metadata as it is displayed on PyPI. for " "xclim there are three maintainers listed with their profile pictures and " "github user names to the right." msgstr "" From c5c7efb45f11547255644d40add9231670830411 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Tue, 20 Aug 2024 20:25:34 +0900 Subject: [PATCH 23/38] docs: fix the Unicode apostrophe issue in markdown files --- .../python-package-distribution-files-sdist-wheel.md | 2 +- tutorials/installable-code.md | 8 ++++---- tutorials/pyproject-toml.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-structure-code/python-package-distribution-files-sdist-wheel.md b/package-structure-code/python-package-distribution-files-sdist-wheel.md index d53990f9..87713be5 100644 --- a/package-structure-code/python-package-distribution-files-sdist-wheel.md +++ b/package-structure-code/python-package-distribution-files-sdist-wheel.md @@ -78,7 +78,7 @@ Project metadata used to be stored in either a setup.py file or a setup.cfg file ### An example - xclim -When you publish to PyPI, you will notice that each package has metadata listed. Let’s have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata and print it out on their website. +When you publish to PyPI, you will notice that each package has metadata listed. Let's have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata and print it out on their website. ```{figure} ../images/python-build-package/pypi-metadata-classifiers.png :scale: 50 % diff --git a/tutorials/installable-code.md b/tutorials/installable-code.md index 3f5c0251..8aabdd35 100644 --- a/tutorials/installable-code.md +++ b/tutorials/installable-code.md @@ -80,7 +80,7 @@ To make your Python code installable you need to create a specific directory str - Some code. - An `__init__.py` file in your code directory. -The directory structure you’ll create in this lesson will look like this: +The directory structure you'll create in this lesson will look like this: ```bash pyospackage/ # Your project directory @@ -118,7 +118,7 @@ import pyospackage The **pyproject.toml** file is: -- Where you define your project’s metadata (including its name, authors, license, etc) +- Where you define your project's metadata (including its name, authors, license, etc) - Where you define dependencies (the packages that it depends on) - Used to specify and configure what build backend you want to use to [build your package](../package-structure-code/python-package-distribution-files-sdist-wheel). @@ -279,7 +279,7 @@ Python can support many different docstrings formats depending on the documentat **pyOpenSci recommends using the NumPy Docstring convention.** -If you aren’t familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics. +If you aren't familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics. ```python def add_num(a: int, b: int) -> int: @@ -480,7 +480,7 @@ Source = "https://github.com/unknown/pyospackage" The core information that you need in a `pyproject.toml` file in order to publish on PyPI is your **package's name** and the **version**. However, we suggest that you flesh out your metadata early on in the `pyproject.toml` file. Once you have your project metadata in the pyproject.toml file, you will -rarely update it. In the next lesson you’ll add more metadata and structure to this file. +rarely update it. In the next lesson you'll add more metadata and structure to this file. ::: ## Step 5: Install your package locally diff --git a/tutorials/pyproject-toml.md b/tutorials/pyproject-toml.md index 67af859e..56728764 100644 --- a/tutorials/pyproject-toml.md +++ b/tutorials/pyproject-toml.md @@ -40,7 +40,7 @@ When creating your pyproject.toml file, consider the following: * **name=** * **version=** 3. You should add more metadata to the `[project]` table as it will make it easier for users to find your project on PyPI. And it will also make it easier for installers to understand how to install your package. -3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPI’s classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI. +3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPI's classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI. 4. There is no specific order for tables in the `pyproject.toml` file. However, fields need to be placed within the correct tables. For example `requires =` always need to be in the **[build-system]** table. 5. We suggest that you include your **[build-system]** table at the top of your `pyproject.toml` file. ::: From ab964af8bee7a83ca1a7ebafc279cb93bec5a287 Mon Sep 17 00:00:00 2001 From: Naty Clementi Date: Tue, 20 Aug 2024 17:57:23 -0400 Subject: [PATCH 24/38] chore: fix typo Co-authored-by: Felipe Moreno --- locales/es/LC_MESSAGES/tutorials.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index 62ca6bbc..ac44f016 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -78,7 +78,7 @@ msgstr "¿Qué es una licencia?" msgid "" "A license contains legal language about how users can use and reuse your " "software. To set the `LICENSE` for your project, you:" -msgstr "Una licencia contiene lenguage legal acerca de como los usuarios pueden " +msgstr "Una licencia contiene lenguaje legal acerca de como los usuarios pueden " "usar y reusar tu software. Para establecer un archivo `LICENSE` para tu" " projecto, tu: " From d7997b5a136bde747a147c761665c71c7206b6ce Mon Sep 17 00:00:00 2001 From: Naty Clementi Date: Tue, 20 Aug 2024 17:57:32 -0400 Subject: [PATCH 25/38] chore: fix typo Co-authored-by: Felipe Moreno --- locales/es/LC_MESSAGES/tutorials.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index ac44f016..31bed78a 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -40,7 +40,7 @@ msgid "" "Learned about the core components that are useful to have in a `README` " "file." msgstr "Aprendiste acerca de los componentes principales que son útiles de tener en " -"un `README` file." +"un archivo `README`." #: ../../tutorials/add-license-coc.md:9 ../../tutorials/add-readme.md:10 msgid "Learning objectives" From 3e0e1b036798d69278a5d2b7db6884463e3b0789 Mon Sep 17 00:00:00 2001 From: Naty Clementi Date: Tue, 20 Aug 2024 17:57:43 -0400 Subject: [PATCH 26/38] chore: fix typo Co-authored-by: Felipe Moreno --- locales/es/LC_MESSAGES/tutorials.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index 31bed78a..7b2811f9 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -102,7 +102,7 @@ msgid "" "GitHub repository's landing page interface." msgstr "Al incluir el archivo `LICENSE` en tu archivo `pyproject.toml`, la " "`LICENSE` sera incluída en la metadata de tu paquete y esta es utilizada para" -" rellenar la página de entrada de tu paquete en PyPI. La `LICENSE` tambien es " +" rellenar la página de entrada de tu paquete en PyPI. La `LICENSE` también es " " utilizada en la página de entrada de tu repositorio de GitHub" #: ../../tutorials/add-license-coc.md:28 From 695c4b47843c0b3371e965a382b73c2d3c718617 Mon Sep 17 00:00:00 2001 From: Naty Clementi Date: Tue, 20 Aug 2024 17:58:03 -0400 Subject: [PATCH 27/38] chore: fix typo Co-authored-by: Felipe Moreno --- locales/es/LC_MESSAGES/tutorials.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index 7b2811f9..ebabf01f 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -107,7 +107,7 @@ msgstr "Al incluir el archivo `LICENSE` en tu archivo `pyproject.toml`, la " #: ../../tutorials/add-license-coc.md:28 msgid "What license should you use?" -msgstr "¿Qué licencia debería elegir?" +msgstr "¿Qué licencia deberías elegir?" #: ../../tutorials/add-license-coc.md:30 msgid "" From e221e7b843abe37f87036100f8c2c69edc0dcd1e Mon Sep 17 00:00:00 2001 From: Naty Clementi Date: Tue, 20 Aug 2024 17:58:27 -0400 Subject: [PATCH 28/38] chore: fix typo Co-authored-by: Felipe Moreno --- locales/es/LC_MESSAGES/tutorials.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locales/es/LC_MESSAGES/tutorials.po b/locales/es/LC_MESSAGES/tutorials.po index ebabf01f..9dbb7a74 100644 --- a/locales/es/LC_MESSAGES/tutorials.po +++ b/locales/es/LC_MESSAGES/tutorials.po @@ -116,7 +116,7 @@ msgid "" " and BSD-3[^bsd3]). If you are unsure, use MIT given it's the generally " "recommended license on [choosealicense.com](https://choosealicense.com/)." msgstr "Nosotros sugerimos que uses una licencia permissiva que acomode otras" -" licencias comunmente usadas en el ecosistema de Python científico (MIT[^mit]" +" licencias comúnmente usadas en el ecosistema de Python científico (MIT[^mit]" " and BSD-3[^bsd3]). Si tienes dudas, usa MIT dado que es la licencia" " generalmente recomendada en [choosealicense.com](https://choosealicense.com/)" From 1d93adebe0e6338281069c50b84d8c476262638d Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 23 Aug 2024 07:34:01 +0900 Subject: [PATCH 29/38] docs: add ncclementi as a contributor for translation (#391) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 5df4d977..ea7f3752 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -730,7 +730,8 @@ "profile": "https://www.linkedin.com/in/ncclementi/", "contributions": [ "code", - "review" + "review", + "translation" ] }, { diff --git a/README.md b/README.md index bfeb838f..0b04e3ed 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d hpodzorski-USGS
hpodzorski-USGS
💻 👀 - Naty Clementi
Naty Clementi
💻 👀 + Naty Clementi
Naty Clementi
💻 👀 🌍 John Drake
John Drake
💻 👀 Revathy Venugopal
Revathy Venugopal
💻 👀 📖 Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍 From 032eb9c634fa2252a36ae4d263205c379a7f7175 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 23 Aug 2024 14:49:04 +0900 Subject: [PATCH 30/38] Drop "vanilla of" from sentence --- documentation/hosting-tools/myst-markdown-rst-doc-syntax.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/hosting-tools/myst-markdown-rst-doc-syntax.md b/documentation/hosting-tools/myst-markdown-rst-doc-syntax.md index 5fb1089b..58d4c6a8 100644 --- a/documentation/hosting-tools/myst-markdown-rst-doc-syntax.md +++ b/documentation/hosting-tools/myst-markdown-rst-doc-syntax.md @@ -6,7 +6,7 @@ syntax. It is the default syntax used in Jupyter Notebooks. There are tools that colored call out blocks and other custom elements to your documentation, you will need to use either **myST** or **rST**. 1. [rST (ReStructured Text):](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html). **rST** is the native syntax that sphinx supports. rST was the default syntax used for documentation for many years. However, in recent years myST has risen to the top as a favorite for documentation given the flexibility that it allows. -1. [myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST is a combination of vanilla of `markdown` and `rST` syntax. It is a nice option if you are comfortable writing markdown. `myst` is preferred by many because it offers both the rich functionality +1. [myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST is a combination of `markdown` and `rST` syntax. It is a nice option if you are comfortable writing markdown. `myst` is preferred by many because it offers both the rich functionality of rST combined with a simple-to-write markdown syntax. While you can chose to use any of the syntaxes listed above, we suggest using From 48474bf5fd82716518938417cb115ccd2f7656ea Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Sat, 24 Aug 2024 05:59:14 +0000 Subject: [PATCH 31/38] docs: update README.md [skip ci] --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0b04e3ed..db5596a3 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍 Carol Willing
Carol Willing
👀 Kozo Nishida
Kozo Nishida
👀 🌍 + Melissa Weber Mendonça
Melissa Weber Mendonça
💬 From 6c6969ea24f27f1c1f30d6dcd35afde33819e3c2 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Sat, 24 Aug 2024 05:59:15 +0000 Subject: [PATCH 32/38] docs: update .all-contributorsrc [skip ci] --- .all-contributorsrc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index ea7f3752..87f247ac 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -785,6 +785,15 @@ "review", "translation" ] + }, + { + "login": "melissawm", + "name": "Melissa Weber Mendonça", + "avatar_url": "https://avatars.githubusercontent.com/u/3949932?v=4", + "profile": "http://melissawm.github.io", + "contributions": [ + "question" + ] } ], "contributorsPerLine": 7, From c7d8a384867ee26a71278e04dd5ea7df675579ef Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Wed, 28 Aug 2024 15:55:14 +0900 Subject: [PATCH 33/38] Fix mirror of the `prettier` npm package for pre-commit --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e5d90f98..36028bc0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,8 +40,8 @@ repos: hooks: - id: vale - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v3.1.0 + - repo: https://github.com/rbubley/mirrors-prettier + rev: v3.3.3 hooks: - id: prettier types_or: [yaml, html, css, scss, javascript, json, toml] From 525e10f18537cca4891b060b09fb642fb768ef9e Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Thu, 29 Aug 2024 11:09:32 -0600 Subject: [PATCH 34/38] docs: add OriolAbril as a contributor for question (#396) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Tetsuo Koyama --- .all-contributorsrc | 9 +++++++++ README.md | 1 + 2 files changed, 10 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 87f247ac..a5254547 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -794,6 +794,15 @@ "contributions": [ "question" ] + }, + { + "login": "OriolAbril", + "name": "Oriol Abril-Pla", + "avatar_url": "https://avatars.githubusercontent.com/u/23738400?v=4", + "profile": "http://oriolabrilpla.cat", + "contributions": [ + "question" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index db5596a3..83127de6 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Carol Willing
Carol Willing
👀 Kozo Nishida
Kozo Nishida
👀 🌍 Melissa Weber Mendonça
Melissa Weber Mendonça
💬 + Oriol Abril-Pla
Oriol Abril-Pla
💬 From ba0106f6a1a80c16bdde5cd4943e1776a2dc9c81 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Mon, 19 Aug 2024 08:13:54 +0900 Subject: [PATCH 35/38] Set Bot configuration `contributorsSortAlphabetically` True --- .all-contributorsrc | 1 + 1 file changed, 1 insertion(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index a5254547..6cfaf855 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -5,6 +5,7 @@ "imageSize": 100, "commit": false, "commitConvention": "angular", + "contributorsSortAlphabetically": true, "contributors": [ { "login": "eriknw", From 0da208cf26369b523764b521fe0150f71efd34d8 Mon Sep 17 00:00:00 2001 From: sneakers-the-rat Date: Thu, 22 Aug 2024 23:27:26 -0700 Subject: [PATCH 36/38] ungoofy the header at intermediate widths --- _static/pyos.css | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/_static/pyos.css b/_static/pyos.css index 52ff4bdb..ff33950e 100644 --- a/_static/pyos.css +++ b/_static/pyos.css @@ -211,6 +211,45 @@ html[data-theme="dark"] { --pyos-h1-color: var(--pyos-color-light); } +/* -------------------------------------- +De-jumble header items. +See https://github.com/pydata/pydata-sphinx-theme/pull/1784 +*/ + +.bd-header .bd-header__inner { + padding: 0 1rem; +} + +.bd-header .navbar-item { + height: unset; + max-height: unset; +} + +@media (max-width: 960px) { + .bd-header .navbar-header-items { + flex-wrap: wrap; + row-gap: 0.5rem; + } +} + +.bd-header .navbar-header-items__end, +.bd-header .navbar-header-items__center, +.bd-header .navbar-header-items__start { + flex-flow: nowrap; +} + +.bd-header .navbar-header-items__start { + width: unset; +} + +.bd-header .navbar-header-items__center { + margin-right: 0.25em !important; +} + +.bd-header ul.navbar-nav { + flex-wrap: wrap; +} + /* -------------------------------------- */ /* Generated by https://gwfh.mranftl.com/ */ From 6531178c92ae5ce7fdd67f28a96bdd706357f641 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 30 Aug 2024 07:47:42 +0900 Subject: [PATCH 37/38] docs: add RobPasMue as a contributor for ideas (#400) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 3 +- README.md | 138 ++++++++++++++++++++++---------------------- 2 files changed, 72 insertions(+), 69 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 6cfaf855..b8825227 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -691,7 +691,8 @@ "contributions": [ "code", "review", - "translation" + "translation", + "ideas" ] }, { diff --git a/README.md b/README.md index 83127de6..aee04169 100644 --- a/README.md +++ b/README.md @@ -74,104 +74,106 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d - - - - - - + + + + + + - - - - - - - + + + + + + + - - - - - + + + + - + + - + + + + + + - - - - - - - - - - + + + + - + + - - + + + - - - - + + + - - - - - - - + + + + + + + - + - - - - + + + + - - - - + + + + - + - - - - - - + + + + + + + + + + + + + + + - - - - - - - - +
Erik Welch
Erik Welch
📖 🎨		David Nicholson
David Nicholson
📖 🎨 ✅		Leah Wasser
Leah Wasser
📖 🎨		Ariane Sasso
Ariane Sasso
📖 🎨 💻 👀		Simon
Simon
📖 🎨		 Alexandre Batisse
Alexandre Batisse
📖 🎨		Pamphile Roy
Pamphile Roy
📖 🎨		Ananthu C V
Ananthu C V
👀		Anderson Bravalheri
Anderson Bravalheri
💻 🎨		Ariane Sasso
Ariane Sasso
📖 🎨 💻 👀		Brianne Wilhelmi
Brianne Wilhelmi
💻 👀		C. Titus Brown
C. Titus Brown
💻 👀		Cale Kochenour
Cale Kochenour
💻 👀
Filipe
Filipe
💻 🎨		Jonny Saunders
Jonny Saunders
💻 🎨		Randy Döring
Randy Döring
💻 👀		Juan Luis Cano Rodríguez
Juan Luis Cano Rodríguez
💻 🎨 👀		Henry Schreiner
Henry Schreiner
💻 🎨 👀		Stefan van der Walt
Stefan van der Walt
💻 🎨 👀		Eli Schwartz
Eli Schwartz
💻 🎨 👀		Carol Willing
Carol Willing
👀		Cheng H. Lee
Cheng H. Lee
💻 👀		Chiara Marmo
Chiara Marmo
💻 🎨 👀		Chris Holdgraf
Chris Holdgraf
💻 👀		Daniel Possenriede
Daniel Possenriede
💻 👀		Dave Hirschfeld
Dave Hirschfeld
👀		David Nicholson
David Nicholson
📖 🎨 ✅
Ralf Gommers
Ralf Gommers
💻 🎨 👀		Pradyun Gedam
Pradyun Gedam
💻 🎨 👀		Ofek Lev
Ofek Lev
💻 🎨 👀 ✅		Chiara Marmo
Chiara Marmo
💻 🎨 👀		James Tocknell
James Tocknell
💻 👀		Eli Schwartz
Eli Schwartz
💻 🎨 👀		Erik Welch
Erik Welch
📖 🎨		Felipe Moreno
Felipe Moreno
👀 💻 🌍		Filipe
Filipe
💻 🎨		 Frost Ming
Frost Ming
💻 👀		Hugo van Kemenade
Hugo van Kemenade
💻 👀		Han
Han
💻 👀		Henry Schreiner
Henry Schreiner
💻 🎨 👀
Matt Hall
Matt Hall
💻 👀		Hugo van Kemenade
Hugo van Kemenade
💻 👀		Inessa Pawson
Inessa Pawson
💻 👀 ✅		Isabel Zimmerman
Isabel Zimmerman
💻 👀		Ivan Ogasawara
Ivan Ogasawara
💻 👀 ✅		Jackson Burns
Jackson Burns
💻 👀 ✅		James Tocknell
James Tocknell
💻 👀		 Jannis Leidel
Jannis Leidel
💻 👀		Dave Hirschfeld
Dave Hirschfeld
👀		Jeremy Paige
Jeremy Paige
💻 👀 ✅ 🚧 📖		Anderson Bravalheri
Anderson Bravalheri
💻 🎨		Daniel Possenriede
Daniel Possenriede
💻 👀		ruoxi
ruoxi
💻 👀
Isabel Zimmerman
Isabel Zimmerman
💻 👀		Nick Murphy
Nick Murphy
💻 👀		Trevor James Smith
Trevor James Smith
💻 👀		Éric
Éric
💻 👀		Karen Cranston
Karen Cranston
💻 👀		Jeremy Paige
Jeremy Paige
💻 👀 ✅ 🚧 📖		Jesse Mostipak
Jesse Mostipak
✅		John Drake
John Drake
💻 👀		Jonny Saunders
Jonny Saunders
💻 🎨		 Joseph H Kennedy
Joseph H Kennedy
💻 👀		Inessa Pawson
Inessa Pawson
💻 👀 ✅		Juan Luis Cano Rodríguez
Juan Luis Cano Rodríguez
💻 🎨 👀		Karen Cranston
Karen Cranston
💻 👀
William F. Broderick
William F. Broderick
✅		Jesse Mostipak
Jesse Mostipak
✅		Ken Seehart
Ken Seehart
💻 👀		Kozo Nishida
Kozo Nishida
👀 🌍		Leah Wasser
Leah Wasser
📖 🎨		 Maria Knorps
Maria Knorps
💻 👀		Philipp A.
Philipp A.
💻 👀		Moritz E. Beber
Moritz E. Beber
💻 ✅		Jackson Burns
Jackson Burns
💻 👀 ✅		jaimergp
jaimergp
💻 👀 ✅		Matt Hall
Matt Hall
💻 👀		Megan Sosey
Megan Sosey
💻 👀		Melissa Weber Mendonça
Melissa Weber Mendonça
💬
h-vetinari
h-vetinari
💻 👀 ✅		Ivan Ogasawara
Ivan Ogasawara
💻 👀 ✅		Tom Russell
Tom Russell
💻 👀 ✅		C. Titus Brown
C. Titus Brown
💻 👀		Cale Kochenour
Cale Kochenour
💻 👀		miguelalizo
miguelalizo
💻 👀 📖		nyeshlur
nyeshlur
💻 👀		Moritz E. Beber
Moritz E. Beber
💻 ✅		Naty Clementi
Naty Clementi
💻 👀 🌍		Neil Chue Hong
Neil Chue Hong
👀		Nick Murphy
Nick Murphy
💻 👀		Ofek Lev
Ofek Lev
💻 🎨 👀 ✅		Olek
Olek
💻 👀		Oriol Abril-Pla
Oriol Abril-Pla
💬
Tyler Bonnell
Tyler Bonnell
💻 👀		Pamphile Roy
Pamphile Roy
📖 🎨		 Pat Tressel
Pat Tressel
💻 👀		Ken Seehart
Ken Seehart
💻 👀		Ryan
Ryan
💻 👀		 Patrick Byers
Patrick Byers
💻 👀		Megan Sosey
Megan Sosey
💻 👀		Brianne Wilhelmi
Brianne Wilhelmi
💻 👀		Philipp A.
Philipp A.
💻 👀		Pradyun Gedam
Pradyun Gedam
💻 🎨 👀		Ralf Gommers
Ralf Gommers
💻 🎨 👀		Randy Döring
Randy Döring
💻 👀
Cheng H. Lee
Cheng H. Lee
💻 👀		Vaunty
Vaunty
💻 👀		Zack Weinberg
Zack Weinberg
👀		Felipe Moreno
Felipe Moreno
👀 💻 🌍		Revathy Venugopal
Revathy Venugopal
💻 👀 📖		Roberto Pastor Muela
Roberto Pastor Muela
💻 👀 🌍 🤔		Ryan
Ryan
💻 👀		Simon
Simon
📖 🎨		 Sneha Yadav
Sneha Yadav
💻 👀		Stefano Rivera
Stefano Rivera
👀		Stefan van der Walt
Stefan van der Walt
💻 🎨 👀		 Stefanie Molin
Stefanie Molin
💻 👀
Ananthu C V
Ananthu C V
👀		Chris Holdgraf
Chris Holdgraf
💻 👀		Neil Chue Hong
Neil Chue Hong
👀		Roberto Pastor Muela
Roberto Pastor Muela
💻 👀 🌍		Olek
Olek
💻 👀		Han
Han
💻 👀		Stefano Rivera
Stefano Rivera
👀		Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍		Tom Russell
Tom Russell
💻 👀 ✅		Trevor James Smith
Trevor James Smith
💻 👀		Tyler Bonnell
Tyler Bonnell
💻 👀		Vaunty
Vaunty
💻 👀		William F. Broderick
William F. Broderick
✅
Zack Weinberg
Zack Weinberg
👀		h-vetinari
h-vetinari
💻 👀 ✅		 hpodzorski-USGS
hpodzorski-USGS
💻 👀		jaimergp
jaimergp
💻 👀 ✅		miguelalizo
miguelalizo
💻 👀 📖		nyeshlur
nyeshlur
💻 👀		ruoxi
ruoxi
💻 👀
Naty Clementi
Naty Clementi
💻 👀 🌍		John Drake
John Drake
💻 👀		Revathy Venugopal
Revathy Venugopal
💻 👀 📖		Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍		Carol Willing
Carol Willing
👀		Kozo Nishida
Kozo Nishida
👀 🌍		Melissa Weber Mendonça
Melissa Weber Mendonça
💬		Oriol Abril-Pla
Oriol Abril-Pla
💬		Éric
Éric
💻 👀
From 5868d1e99a0ae099fbf2d6841eb5b855538a0a96 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Fri, 30 Aug 2024 07:55:37 +0900 Subject: [PATCH 38/38] docs: add tkoyama010 as a contributor for ideas (#401) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 3 ++- README.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index b8825227..93769729 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -766,7 +766,8 @@ "code", "review", "doc", - "translation" + "translation", + "ideas" ] }, { diff --git a/README.md b/README.md index aee04169..861a8bd6 100644 --- a/README.md +++ b/README.md @@ -156,7 +156,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Stefano Rivera
Stefano Rivera
👀 - Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍 + Tetsuo Koyama
Tetsuo Koyama
💻 👀 📖 🌍 🤔 Tom Russell
Tom Russell
💻 👀 ✅ Trevor James Smith
Trevor James Smith
💻 👀 Tyler Bonnell
Tyler Bonnell
💻 👀