Skip to content

Commit

Permalink
Add: collection tutorials to website (#334)
Browse files Browse the repository at this point in the history
  • Loading branch information
lwasser authored Mar 8, 2024
1 parent 05d02b4 commit 0e4d6c0
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 1 deletion.
11 changes: 11 additions & 0 deletions _tutorials/0-hatch-python-packaging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Add metadata using a pyproject.toml file to your Python package"
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:
- "How to install Hatch using either pipx or pip"
- "How to configure hatch using the hatch .toml file"
link: https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---
2 changes: 1 addition & 1 deletion _tutorials/2-make-code-installable.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ excerpt: "
Learn how to create the most basic version of a Python package which can then be installed into a Python environment."
learning_objectives:
- "Understand what a Python package is"
link: https://www.pyopensci.org/python-package-guide/tutorials/1-installable-code.html
link: https://www.pyopensci.org/python-package-guide/tutorials/installable-code.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---
11 changes: 11 additions & 0 deletions _tutorials/4-publish-conda-forge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "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:
- "Create a conda-forge recipe using grayskull"
- "Submit that package for review and publication on conda-forge."
link: https://www.pyopensci.org/python-package-guide/tutorials/publish-conda-forge.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---
11 changes: 11 additions & 0 deletions _tutorials/5-add-readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "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:
- "How to add a README.md file to your package."
- "What the core elements of a README.md file are."
link: https://www.pyopensci.org/python-package-guide/tutorials/add-readme.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---
12 changes: 12 additions & 0 deletions _tutorials/6-add-license-code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "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:
- "How to select and add a LICENSE file to your package repository with a focus on the GitHub interface."
- "How to add a CODE_OF_CONDUCT file to your package repository."
- "How you can use the Contributors Covenant website to add generic language as a starting place for your CODE_OF_CONDUCT."
link: https://www.pyopensci.org/python-package-guide/tutorials/add-license-coc.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---
11 changes: 11 additions & 0 deletions _tutorials/7-add-metadata-pyproject-toml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "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:
- "More about the pyproject.toml file and how it’s used to store different types of metadata about your package"
- "How to declare information (metadata) about your project to help users find and understand it on PyPI."
link: https://www.pyopensci.org/python-package-guide/tutorials/pyproject-toml.html
btn_label: View Tutorial
btn_class: btn--success btn--large
---

0 comments on commit 0e4d6c0

Please sign in to comment.