Skip to content

Commit ac1b26e

Browse files
committed
script to make markdown files
1 parent e4addf7 commit ac1b26e

11 files changed

+124
-0
lines changed

_tutorials/add-license-coc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Add a License and Code of Conduct to your python package"
3+
excerpt: "Learn how to add a LICENSE and CODE_OF_CONDUCT file to your Python package. This lesson covers choosing a permissive license, placing key files for visibility on GitHub and PyPI, and adopting the Contributor Covenant to support an inclusive community."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/add-license-coc.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/add-readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Add a README file to your Python package"
3+
excerpt: "Learn how to create a clear, effective README file for your Python package. This lesson covers what to include, why each section matters, and how a well-structured README improves usability and discoverability on GitHub and PyPI."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/add-readme.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Command Line Reference Guide"
3+
excerpt: "Learn how to add a command-line interface (CLI) to your Python package using the argparse library. This lesson walks you through creating a CLI entry point so users can run your package directly from the terminal."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/command-line-reference.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/get-to-know-hatch.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Get to Know Hatch"
3+
excerpt: "Get started with Hatch, a modern Python packaging tool. This lesson introduces Hatch’s features and shows how it simplifies environment management, project scaffolding, and building your package."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/get-to-know-hatch.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/installable-code.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Make your Python code installable so it can be used across projects"
3+
excerpt: "Learn how to make your code installable as a Python package using Hatch. This lesson walks you through structuring your code and configuring pyproject.toml so others can easily install and use your package."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/installable-code.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/intro.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Python packaging 101"
3+
excerpt: "This page outlines the key steps to create, document, and share a high-quality scientific Python package. Here you will also get an overview of the pyOpenSci packaging guide and what you’ll learn."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/intro.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/publish-conda-forge.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Publish your Python package that is on PyPI to conda-forge"
3+
excerpt: "Learn how to publish your Python package on conda-forge to make it easily installable with conda. This lesson covers the submission process, metadata requirements, and maintaining your feedstock."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/publish-conda-forge.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/publish-pypi.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Publish your Python package to PyPI"
3+
excerpt: "Learn how to publish your Python package on PyPI so others can install it using pip. This lesson covers building your package, creating a PyPI account, and uploading your distribution files."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/publish-pypi.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

_tutorials/pyproject-toml.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Make your Python package PyPI ready - pyproject.toml"
3+
excerpt: "The pyproject.toml file is the central configuration file for building and packaging Python projects. This lesson explains key sections like name, version, dependencies, and how they support packaging and distribution. You’ll learn how to set up this file to ensure your package is ready for publishing."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/pyproject-toml.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Using Hatch to Migrate setup.py to a pyproject.toml"
3+
excerpt: "If you’re creating a pure Python project, pyproject.toml is preferred over setup.py for packaging and configuration. Learn how to migrate from the older setup.py format to the modern pyproject.toml file. This lesson walks you through updating your package metadata and build settings to align with current Python packaging standards."
4+
link: https://www.pyopensci.org/python-package-guide/tutorials/setup-py-to-pyproject-toml.html
5+
btn_label: View Tutorial
6+
btn_class: btn--success btn--large
7+
---

0 commit comments

Comments
 (0)