Merge branch 'main' into patch-9

Author: tkoyama010

.all-contributorsrc

@@ -730,7 +730,8 @@
       "profile": "https://www.linkedin.com/in/ncclementi/",
       "contributions": [
         "code",
-        "review"
+        "review",
+        "translation"
       ]
     },
     {

README.md

@@ -14,8 +14,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.
+* mentorship
+* training
 
 pyOpenSci is an independent organization, fiscally sponsored by Community
 Initiatives.
@@ -164,7 +164,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/hpodzorski-USGS"><img src="https://avatars.githubusercontent.com/u/159824971?v=4?s=100" width="100px;" alt="hpodzorski-USGS"/><br /><sub><b>hpodzorski-USGS</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=hpodzorski-USGS" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Ahpodzorski-USGS" title="Reviewed Pull Requests">👀</a></td>
     </tr>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/ncclementi/"><img src="https://avatars.githubusercontent.com/u/7526622?v=4?s=100" width="100px;" alt="Naty Clementi"/><br /><sub><b>Naty Clementi</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ncclementi" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Ancclementi" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/ncclementi/"><img src="https://avatars.githubusercontent.com/u/7526622?v=4?s=100" width="100px;" alt="Naty Clementi"/><br /><sub><b>Naty Clementi</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ncclementi" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Ancclementi" title="Reviewed Pull Requests">👀</a> <a href="#translation-ncclementi" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/John-Drake"><img src="https://avatars.githubusercontent.com/u/22374979?v=4?s=100" width="100px;" alt="John Drake"/><br /><sub><b>John Drake</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=John-Drake" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AJohn-Drake" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Revathyvenugopal162"><img src="https://avatars.githubusercontent.com/u/104772255?v=4?s=100" width="100px;" alt="Revathy Venugopal"/><br /><sub><b>Revathy Venugopal</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Revathyvenugopal162" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ARevathyvenugopal162" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Revathyvenugopal162" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/tkoyama010"><img src="https://avatars.githubusercontent.com/u/7513610?v=4?s=100" width="100px;" alt="Tetsuo Koyama"/><br /><sub><b>Tetsuo Koyama</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tkoyama010" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Atkoyama010" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyOpenSci/python-package-guide/commits?author=tkoyama010" title="Documentation">📖</a> <a href="#translation-tkoyama010" title="Translation">🌍</a></td>
@@ -180,3 +180,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 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)

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.)
 
@@ -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?
 

locales/es/LC_MESSAGES/tutorials.po

@@ -22,94 +22,107 @@ 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 ""
 "<i class=\"fa-solid fa-circle-check\" style=\"color: #703c87;\"></i> "
 "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 ""
 "<i class=\"fa-solid fa-circle-check\" style=\"color: #703c87;\"></i> "
 "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 archivo `README`."
 
 #: ../../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 lenguaje 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 ""
 "By adding the `LICENSE` file to your `pyproject.toml` file, the `LICENSE`"
 " 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` también 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ías elegir?"
 
 #: ../../tutorials/add-license-coc.md:30
 msgid ""
 "We suggest that you use a permissive license that accommodates the other "
 "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 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/)"
 
 #: ../../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 ""

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 %

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:

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.
 :::

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.
 

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
 

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

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.
 

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.
 :::