Skip to content

Latest commit

 

History

History
131 lines (96 loc) · 3.33 KB

index.md

File metadata and controls

131 lines (96 loc) · 3.33 KB

pyOpenSci Lessons

![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)
[![View Contributors](images/contributing/contributors-badge.svg)](https://github.com/pyOpenSci/lessons#contributors-)
[![Binder](https://binder.opensci.2i2c.cloud/badge_logo.svg)](https://binder.opensci.2i2c.cloud/v2/gh/pyopensci/lessons/HEAD)

:::::{grid} 2

::::{grid-item} :::{card} ✿ Clean Code ✿ :class-card: left-aligned

::: ::::

::::{grid-item} :::{card} ✿ Code Checks ✿ :class-card: left-aligned

::: ::::

::::{grid-item} :::{card} ✿ Running Code ✿ :class-card: left-aligned

::: ::::

::::{grid-item} :::{card} ✿ Share Code ✿ :class-card: left-aligned

::: ::::

::::{grid-item} :::{card} ✿ Collaborative GitHub ✿ :class-card: left-aligned

Learn how to make your first contribution to an open source code hosted on GitHub. Here you'll learn how to

::: ::::

:::::

Who are these lessons for

These lessons help scientists understand best practices and tools used in the Python ecosystem. We will be adding new lessons over the next year.

In these lessons, we'll be covering topics that encourage efficient, maintainable, and reproducible code. We start out by introducing the concepts of "clean code" and "Pythonic code". Then, we move into how you can achieve clean, Pythonic code using best practices and tools.

:::{toctree} :hidden: :caption: Clean Code :maxdepth: 2

Clean Code <clean-modular-code/intro-clean-code> :::

:::{toctree} :hidden: :caption: Optimize Code :maxdepth: 2

Optimize Code <code-workflow-logic/intro> :::

:::{toctree} :hidden: :caption: Running Code :maxdepth: 2

Package Code <running-code/intro> :::

:::{toctree} :hidden: :caption: Share Code :maxdepth: 2

Share Code <publish-share-code/intro> :::

:::{toctree} :hidden: :caption: GitHub :maxdepth: 2

Collaborative GitHub <github-git/intro> :::

:::{todolist}

:::