From 5b4c8dc6ca8d93977fab7fd7ab24a75b2ddd07a1 Mon Sep 17 00:00:00 2001 From: Gabriel Stefanini Vicente Date: Tue, 25 Jun 2024 14:04:06 -0400 Subject: [PATCH 1/2] Rename and fix tutorial card titles --- _tutorials/0-hatch-python-packaging.md | 2 +- _tutorials/1-what-is-package.md | 2 +- _tutorials/2-make-code-installable.md | 2 +- _tutorials/3-publish-to-pypi.md | 2 +- _tutorials/4-publish-conda-forge.md | 2 +- _tutorials/5-add-readme.md | 2 +- _tutorials/6-add-license-code-of-conduct.md | 2 +- _tutorials/7-add-metadata-pyproject-toml.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/_tutorials/0-hatch-python-packaging.md b/_tutorials/0-hatch-python-packaging.md index 44778f0a..9ce089df 100644 --- a/_tutorials/0-hatch-python-packaging.md +++ b/_tutorials/0-hatch-python-packaging.md @@ -1,5 +1,5 @@ --- -title: "Add metadata using a pyproject.toml file to your Python package" +title: "0. Get to know Hatch" excerpt: " Hatch is an end-to-end Python packaging and workflow tool. In this tutorial, you will install and learn how to configure Hatch for Python packaging." learning_objectives: diff --git a/_tutorials/1-what-is-package.md b/_tutorials/1-what-is-package.md index b0e3957b..a415a31e 100644 --- a/_tutorials/1-what-is-package.md +++ b/_tutorials/1-what-is-package.md @@ -1,5 +1,5 @@ --- -title: "What is a Python package" +title: "1. What is a Python package" excerpt: " Learn about what a Python package is and the basic components that make up a Python package." learning_objectives: diff --git a/_tutorials/2-make-code-installable.md b/_tutorials/2-make-code-installable.md index 170b61d5..2d1939be 100644 --- a/_tutorials/2-make-code-installable.md +++ b/_tutorials/2-make-code-installable.md @@ -1,5 +1,5 @@ --- -title: "Make your Python code installable" +title: "2. Make your Python code installable" excerpt: " Learn how to create the most basic version of a Python package which can then be installed into a Python environment." learning_objectives: diff --git a/_tutorials/3-publish-to-pypi.md b/_tutorials/3-publish-to-pypi.md index 534666a5..7ccf7084 100644 --- a/_tutorials/3-publish-to-pypi.md +++ b/_tutorials/3-publish-to-pypi.md @@ -1,5 +1,5 @@ --- -title: "Publish your Python package to PyPI" +title: "3. Publish your Python package to PyPI" excerpt: " Learn how to publish your Python package to test.PyPI.org and to PyPI.org." learning_objectives: diff --git a/_tutorials/4-publish-conda-forge.md b/_tutorials/4-publish-conda-forge.md index 838a3830..6d5e1c0d 100644 --- a/_tutorials/4-publish-conda-forge.md +++ b/_tutorials/4-publish-conda-forge.md @@ -1,5 +1,5 @@ --- -title: "Publish your Python package to conda forge using grayskull" +title: "4. Publish your Python package to conda forge using grayskull" excerpt: " Learn how to publish your Python package to the conda-forge channel of conda using the grayskull Python package." learning_objectives: diff --git a/_tutorials/5-add-readme.md b/_tutorials/5-add-readme.md index 62636772..32ae2cbf 100644 --- a/_tutorials/5-add-readme.md +++ b/_tutorials/5-add-readme.md @@ -1,5 +1,5 @@ --- -title: "Add a README file to your Python package" +title: "5. Add a README file to your Python package" excerpt: " A README file is often the landing page that a user will use to understand your package. Learn about how to create a useful README file for your Python package." learning_objectives: diff --git a/_tutorials/6-add-license-code-of-conduct.md b/_tutorials/6-add-license-code-of-conduct.md index 056213dd..1466f84c 100644 --- a/_tutorials/6-add-license-code-of-conduct.md +++ b/_tutorials/6-add-license-code-of-conduct.md @@ -1,5 +1,5 @@ --- -title: "Add a LICENSE and Code_of_Conduct file to your Python package" +title: "6 . Add a LICENSE and CODE_OF_CONDUCT file to your Python package" excerpt: " License and code of conduct files are important to add to your Python package as they provide instructions for both how users can use your package and also how the community of users should interact with you as a maintainer." learning_objectives: diff --git a/_tutorials/7-add-metadata-pyproject-toml.md b/_tutorials/7-add-metadata-pyproject-toml.md index 62ac9148..a48a5b23 100644 --- a/_tutorials/7-add-metadata-pyproject-toml.md +++ b/_tutorials/7-add-metadata-pyproject-toml.md @@ -1,5 +1,5 @@ --- -title: "Add metadata using a pyproject.toml file to your Python package" +title: "7. Add metadata using a pyproject.toml file to your Python package" excerpt: " To enhance the visibility of your package on PyPI and provide more information about its compatibility with Python versions, project development status, and project maintainers, you should add additional metadata to your pyproject.toml file. This lesson will guide you through the process." learning_objectives: From fa6d3c61baa5ab49de493268d5ea736f2e2ad2ce Mon Sep 17 00:00:00 2001 From: Gabriel Stefanini Vicente Date: Tue, 25 Jun 2024 14:16:11 -0400 Subject: [PATCH 2/2] Update note on Learn page --- _pages/learn.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/_pages/learn.md b/_pages/learn.md index 42c48663..4e665966 100644 --- a/_pages/learn.md +++ b/_pages/learn.md @@ -57,9 +57,7 @@ toc: false ## Start learning: Beginner-friendly Python packaging tutorials -Beginner-friendly Python packaging tutorials that will take you through -the full process of creating a Python package, following modern best -practices. +Beginner-friendly Python packaging tutorials guide you through creating a Python package, following modern best practices. It's best to follow the tutorials in order, but you can always pick a specific topic if you wish to jump around.
{% for atutorial in site.tutorials %}