deploy: 1191048

pyOpenSci · Mar 4, 2024 · 79d79f3 · 79d79f3
1 parent 0949409
commit 79d79f3
Show file tree

Hide file tree

Showing 40 changed files with 3,105 additions and 180 deletions.
diff --git a/.doctrees/documentation/repository-files/license-files.doctree b/.doctrees/documentation/repository-files/license-files.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/tutorials/1-installable-code.doctree b/.doctrees/tutorials/1-installable-code.doctree
diff --git a/.doctrees/tutorials/add-license-coc.doctree b/.doctrees/tutorials/add-license-coc.doctree
diff --git a/.doctrees/tutorials/add-readme.doctree b/.doctrees/tutorials/add-readme.doctree
diff --git a/.doctrees/tutorials/intro.doctree b/.doctrees/tutorials/intro.doctree
diff --git a/.doctrees/tutorials/publish-pypi.doctree b/.doctrees/tutorials/publish-pypi.doctree
diff --git a/.doctrees/tutorials/pyproject-toml.doctree b/.doctrees/tutorials/pyproject-toml.doctree
diff --git a/_images/github-new-repo.png b/_images/github-new-repo.png
diff --git a/_images/license-github-root-dir.png b/_images/license-github-root-dir.png
diff --git a/...ocial_previews/summary_index_9e185de9.png → ...ocial_previews/summary_index_0393342e.png b/...ocial_previews/summary_index_9e185de9.png → ...ocial_previews/summary_index_0393342e.png
diff --git a/_images/social_previews/summary_tutorials_add-license-coc_24d43578.png b/_images/social_previews/summary_tutorials_add-license-coc_24d43578.png
diff --git a/...summary_tutorials_add-readme_05ea09e7.png → ...summary_tutorials_add-readme_cb98e8e2.png b/...summary_tutorials_add-readme_05ea09e7.png → ...summary_tutorials_add-readme_cb98e8e2.png
diff --git a/_images/social_previews/summary_tutorials_publish-pypi_177e2026.png b/_images/social_previews/summary_tutorials_publish-pypi_177e2026.png
diff --git a/_images/social_previews/summary_tutorials_publish-pypi_a4a4bd2f.png b/_images/social_previews/summary_tutorials_publish-pypi_a4a4bd2f.png
diff --git a/_images/social_previews/summary_tutorials_pyproject-toml_1a4c4a0e.png b/_images/social_previews/summary_tutorials_pyproject-toml_1a4c4a0e.png
diff --git a/_images/view-license-github.png b/_images/view-license-github.png
diff --git a/_sources/documentation/repository-files/license-files.md.txt b/_sources/documentation/repository-files/license-files.md.txt
@@ -47,7 +47,7 @@ To select your license, we suggest that you use GitHub's
 [Choose a License tool ](https://choosealicense.com/).
 
 If you choose your license when creating a new GitHub repository, you can also
-automatically get a text copy of the license file to add to your repo. However
+automatically get a text copy of the license file to add to your repository. However
 in some cases the license that you want is not available through that online
 process.
 
@@ -78,9 +78,9 @@ with the license that you selected for your package.
 :::{admonition} An example of how a license determine how code can be reused
 :class: note
 
-Let's use stackOverflow as an example that highlights how a license determines how code can or can not be used.
+Let's use StackOverflow as an example that highlights how a license determines how code can or can not be used.
 
-[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from stackoverflow.
+[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from StackOverflow.
 
 This means that technically, if you copy code from the Stack Overflow website, and use it in your package. And your packages uses a different license such as a MIT license, you are violating Stack Overflow's license requirements!
 
@@ -92,7 +92,7 @@ This means that technically, if you copy code from the Stack Overflow website, a
 
 While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using zenodo.
 
-<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with zenodo (do they work??) will the citation info update with a new zenodo link
+<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
 
 These files - we need to understand if that date releases auto populates or forces zenodo to modify it's citation. if it's not dynamic it could be problematic
 

diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -56,7 +56,7 @@ Community docs
 
 Publish your docs
 ```
-## _new_ Tutorial series - how to create a Python package
+## _new_ Tutorial Series: How to Create a Python Package
 
 The how to create a Python package tutorial series is being developed
 by the community now! Join our community review process or watch development of these tutorials in our [Github repo here](https://github.com/pyOpenSci/python-package-guide).
@@ -67,18 +67,32 @@ by the community now! Join our community review process or watch development of
 :gutter: 3
 
 ::::{grid-item}
-
-:::{card} ✿ Tutorials ✿
+:::{card} ✿ Create a Package Tutorials ✿
 :class-card: left-aligned
 
 * [What is a Python package?](/tutorials/intro)
 * [Make your code installable](/tutorials/1-installable-code)
 * [Publish your package to (test) PyPi](/tutorials/publish-pypi)
-* *How to add a README and LICENSE to support publication (coming next!)*
-* *How to add metadata to a pyproject.toml file for publication to PyPI.*
+* [Publish your package to conda-forge](/tutorials/publish-conda-forge)
+
+:::
+::::
+
+::::{grid-item}
+:::{card} ✿ Package Metadata Tutorials ✿
+:class-card: left-aligned
 
-_The third lesson is currently under review in our [GitHub Repo here](https://github.com/pyOpenSci/python-package-guide/pulls). It will be live by the end of Feb 2024_
+* [How to add a README file](/tutorials/add-readme)
+* [How to add metadata to a pyproject.toml file for publication to PyPI.](/tutorials/pyproject-toml.md)
+
+:::
+::::
+
+::::{grid-item}
+:::{card} ✿ Packaging Tool Tutorials ✿
+:class-card: left-aligned
 
+* [Introduction to Hatch](/tutorials/get-to-know-hatch)
 
 :::
 ::::

diff --git a/_sources/tutorials/1-installable-code.md.txt b/_sources/tutorials/1-installable-code.md.txt
@@ -331,10 +331,9 @@ file.
 [Learn more about the pyproject.toml format here.](../package-structure-code/pyproject-toml-python-package-metadata)
 :::
 
-:::{todo}
+
 You will learn more about the `pyproject.toml` format in the
-[next lesson when you add additional metadata / information to this file.](5-pyproject-toml.md)
-:::
+[next lesson when you add additional metadata / information to this file.](pyproject-toml.md)
 
 - Open up the `pyproject.toml` file that Hatch created in your favorite text editor. It should look something like the example below.
 
@@ -614,13 +613,12 @@ In the upcoming lessons you will:
 * Add more metadata to your `pyproject.toml` file to support PyPI publication.
 * learn how to publish to **conda-forge** from **PyPI**.
 
-:::{todo}
-This is the content with links once the links are live we can uncomment this and remove the unlinked content above!
-* Add a [README file](2-add-readme.md) and [LICENSE](4-add-license-file.md) to your package
+
+* Add a [README file](add-readme.md) and [LICENSE](add-license-coc.md) to your package
 * [Add more metadata to your `pyproject.toml`](5-pyproject-toml.md) file to support PyPI publication.
-* [Learn how to build your package distribution](6-publish-pypi.md) files (**sdist** and **wheel**) and publish to **test PyPI**.
-* Finally you will learn how to publish to **conda-forge** from **PyPI**.
-:::
+* [Learn how to build your package distribution](publish-pypi) files (**sdist** and **wheel**) and publish to **test PyPI**.
+* Finally you will learn how to [publish to **conda-forge**](publish-conda-forge) from **PyPI**.
+
 
 ## Footnotes
 

diff --git a/_sources/tutorials/add-license-coc.md.txt b/_sources/tutorials/add-license-coc.md.txt
@@ -0,0 +1,203 @@
+# Add a LICENSE & CODE_OF_CONDUCT to your Python package
+
+In the [previous lesson](add-readme) you:
+
+<i class="fa-solid fa-circle-check" style="color: #703c87;"></i> Created a basic `README.md` file for your scientific Python package
+
+<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.
+
+:::{admonition} Learning objectives
+:class: tip
+
+In this lesson you will learn:
+
+1. How to select and add a `LICENSE` file to your package repository with a focus on the GitHub interface.
+2. How to add a `CODE_OF_CONDUCT` file to your package repository.
+3. How you can use the Contributors Covenant website to add generic language as a starting place for your `CODE_OF_CONDUCT`.
+:::
+
+## What is a license?
+
+A license contains legal language about how users can use and reuse your software. To set the LICENSE for your project, you:
+
+1. create LICENSE file in your project directory that specifies the license that you choose for your package and
+2. reference that file in your pyproject.toml data where metadata are set.
+
+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.
+
+### What license should you use?
+
+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/).
+
+:::{admonition} Licenses for the scientific Python ecosystem
+[We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](../documentation/repository-files/license-files)
+:::
+
+### Where should the LICENSE file live
+
+Your `LICENSE` file should be placed at the root of your package's repository.
+When you add the LICENSE at the root, GitHub will automagically discover it and
+provide users with a direct link to your license file within your GitHub
+repository.
+
+:::{figure-md} github-coc-readme-license-tabs
+<img src="../images/license-github-root-dir.png" alt="Image showing the GitHub repository for SunPy an accepted pyOpenSci package." width="500px">
+
+Notice at the top of the
+README portion of the GitHub landing page, there are three tabs directly linking to the README file which is visible, the CODE_OF_CONDUCT file and one that specifies
+the license that SunPy uses. These files are discovered by GitHub because they
+are placed in the root of the project directory using standard naming conventions.
+:::
+
+
+### How to add a LICENSE file to your package directory
+
+There are several ways to add a LICENSE file:
+
+1. When you create a new repository on GitHub, it will ask you if you wish to add a `LICENSE` file at that time. If you select yes, it will create the file for you.
+2. You can add a license through the GitHub gui following the [<i class="fa-brands fa-github"></i> instructions here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository).
+3. You can add the file manually like we are doing in this lesson.
+
+:::{tip}
+If you completed the past lessons including
+
+1. [Making your code installable](1-installable-code.md) and
+2. [publishing your package to PyPI](publish-pypi.md)
+
+then you already have a **LICENSE** file containing text for the MIT license in your Python package. Thus you can skip to the next section of this tutorial which walks you through adding a CODE_OF_CONDUCT.
+
+If you don't yet have a **LICENSE** file in your directory, then continue reading.
+:::
+
+### How to add a LICENSE to your package - the manual way
+
+If you don't already have a LICENSE file, and you are not yet using a platform such as GitHub or GitLab, then you can create a license file by
+
+1. Create a new file called LICENSE. If you are using shell you can type:
+
+```
+# Create a license file in your shell
+> touch LICENSE
+```
+
+1. Go to [choosealicense.com](https://choosealicense.com/)
+2. Select permissive license
+3. It will suggest that you use the [MIT license](https://choosealicense.com/licenses/mit/).
+4. Copy the license text that it provides into your LICENSE file that you created above.
+5. Save your file. You're all done!
+
+:::{admonition} An overview of LICENSES in the scientific Python ecosystem
+:class: note
+
+In the pyOpenSci [packaging guidebook](../documentation/repository-files/license-files), we provide an overview of license in the scientific Python ecosystem. We review why license files are important, which ones are most commonly used for scientific software and how to select the correct license.
+
+If you want a broad overview of why licenses are important for protecting open source software, [check out this blog post that overviews the legal side of things.](https://opensource.guide/legal/#just-give-me-the-tldr-on-what-i-need-to-protect-my-project)
+:::
+
+::::::{dropdown} Instructions for adding a license files within the GitHub interface
+:color: primary
+
+:::::{tab-set}
+
+::::{tab-item} Add license: new GitHub repository
+
+When you create a new GitHub repository you can add a license
+through the GitHub interface.
+
+:::{figure-md} github-new-repo
+
+<img src="../images/tutorials/github-new-repo.png" alt="Screenshot of the create new repository interface that GitHub provides. The elements of this are the owner and repository name for the new repo. Below that you can add a description of the repository. Below that you can set it to be public or private. At the bottom of the interface there is an Add a README checkbox where it will add a blank readme file for you. At the very bottom there is a line to add a .gitignore file and another to choose a license." width="500px">
+
+Image showing the GitHub interface that allows you to add a LICENSE and README file when you create a new repository.
+:::
+::::
+
+::::{tab-item} Add License: Existing GitHub repository
+
+If you already have a GitHub repository for your package, then you can add a LICENSE using the GitHub interface by adding a new file to the repository.
+
+- Follow the instructions to select and add a license to your repository on the [GitHub LICENSE page](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) .
+- Once you have added your LICENSE file, be sure to sync your git local repository with the repository on GitHub.com. This means running `git pull` to update your local branch.
+
+:::{figure-md} view-license
+<img src="../images/tutorials/view-license-github.png" alt="Image showing what the LICENSE file looks like in the GItHub interface. At the top you can see the actual license which in this image is BSD 3-clause New or revised license. Then there is some text describing both what the license is and the associated permissions for that specific license. At the bottom of the image, the actual text for the license is shown in the LICENSE file." width="500px">
+
+You can view a summary of the LICENSE chosen on your project's
+GitHub landing page.
+:::
+::::
+
+:::::
+::::::
+
+Now you know how to add a LICENSE to your project. Next, you'll learn
+about the `CODE_OF_CONDUCT.md` file and how to add it to your
+package directory.
+
+(add-coc)=
+## What is a code of conduct file?
+
+A `CODE_OF_CONDUCT` file is used to establish guidelines for how people in your community interact.
+
+This file is critical to supporting your community as it
+grows. The `CODE_OF_CONDUCT`:
+
+1. Establishes guidelines for how users and contributors interact with each other and you in your software repository.
+2. Identifies negative behaviors that you don't want in your interactions.
+
+You can use your code of conduct as a tool that can be referenced when moderating challenging conversations.
+
+### What to put in your code of conduct file
+
+If you are unsure of what language to add to your `CODE_OF_CONDUCT`
+file, we suggest that you adopt the [contributor covenant language](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as a starting place.
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](#)
+
+The `CODE_OF_CONDUCT.md` should be placed at the root of your project directory, similar to the LICENSE file.
+
+### How to add a CODE_OF_CONDUCT file to your package directory
+
+- Add a `CODE_OF_CONDUCT.md` file to the root of your repository if it doesn't already exist.
+
+```bash
+> touch CODE_OF_CONDUCT.md
+```
+
+- Visit the [contributor covenant website](https://www.contributor-covenant.org/) and add [the markdown version of their code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) to your `CODE_OF_CONDUCT.md` file. Read the text closely to ensure you both understand it and also agree with its contents!
+
+That's it - you've now added a code of conduct to your package directory.
+
+:::{admonition} Additional Code of Conduct resources
+:class: note
+
+- [<i class="fa-brands fa-github"></i> Guide: `CODE_OF_CONDUCT.md` files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
+- [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)
+
+:::
+
+## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
+
+In this lesson and the [last lesson](add-readme), you have added a:
+
+- `README` file;
+- `LICENSE` file and a
+- `CODE_OF_CONDUCT` file.
+
+These are fundamental files needed for every scientific Python package
+repository. These files help users understand how to use your package and
+interact with package maintainers.
+
+In the upcoming lessons, you will:
+
+- [Add more metadata to your `pyproject.toml` file](pyproject-toml) to support building and publishing your package on PyPI.
+- Publish a new version of your Python package to (Test) PyPI to preview the
+  updated metadata landing page.
+
+---
+
+## Footnotes
+
+[^mit]: https://opensource.org/license/mit/
+[^bsd3]: https://opensource.org/license/bsd-3-clause/