Skip to content

Commit 24ebbc9

Browse files
lwasserucodery
andauthored
Fix: Edits from @ucodery
Co-authored-by: Jeremy Paige <ucodery@gmail.com>
1 parent 8afe183 commit 24ebbc9

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

tutorials/add-license-coc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Your `LICENSE` file should be placed at the root of your package's repository.
3232

3333
There are several ways to add a license file:
3434

35-
1. When you create a new repository on GitHub, it will ask you if you wish to add a `LICENSE` file at that time. It will also create the file for you.
35+
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.
3636
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).
3737
3. You can add the file manually like we are doing in this lesson.
3838

@@ -42,7 +42,7 @@ If you completed the past lessons including
4242
1. [Making your code installable](1-installable-code.md) and
4343
2. [publishing your package to PyPI](publish-pypi.md)
4444

45-
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 tutorials which walks you through adding a CODE_OF_CONDUCT.
45+
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.
4646

4747
If you don't yet have a **LICENSE** file in your directory, then continue reading.
4848
:::
@@ -51,7 +51,7 @@ If you don't yet have a **LICENSE** file in your directory, then continue readin
5151

5252
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
5353

54-
1. Create a new file called LICENSE. If you are using shell you can use:
54+
1. Create a new file called LICENSE. If you are using a shell you can use:
5555

5656
```
5757
# Create a license file in your shell
@@ -100,7 +100,7 @@ If you already have a GitHub repo for your package, then you can add a LICENSE u
100100
:::{figure-md} view-license
101101
<img src="../images/tutorials/view-license-github.png" alt="sdfsdfsd nasdfjsdf" width="500px">
102102

103-
You can also view an overview of the license on GitHub if you view it in the GitHub interface.
103+
You can also view a summary of the license on its GitHub landing page.```
104104
:::
105105
::::
106106

tutorials/pyproject-toml.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ is 2 above enough for examples? should we show a few others?
1515

1616
In [the installable code lesson](2-installable-code), you learned how to add the bare minimum information to a `pyproject.toml` file to make it installable. You then learned how to [publish that bare minimum version of your package to PyPI](publish-pypi.md).
1717

18-
FOllowing that you learned how to add a:
18+
Following that you learned how to add a:
1919
* [README.md](add-readme)
2020
* [LICENSE](add-license-coc) and
2121
* [CODE_OF_CONDUCT](add-coc)
@@ -29,7 +29,6 @@ file. This
2929
lesson will guide you through the process.
3030

3131

32-
In future lessons you will add a license and README file to your package which will further flesh out both your PyPI landing page and the landing page
3332
of your GitHub or GitLab repository.
3433

3534
:::{admonition} Learning Objectives
@@ -46,7 +45,7 @@ If you wish to learn more about the `pyproject.toml` format, [check out this pag
4645
<!-- TODO:Friends - As you are reviewing ...as a beginner is this TLDR too technical when you have no idea what the elements in it are? or is it a nice summary? -->
4746

4847

49-
:::{dropdown} Click for Lesson highlights TL&DR
48+
:::{dropdown} Click for lesson highlights
5049
:color: secondary
5150
:icon: unlock
5251

@@ -67,9 +66,9 @@ When creating your pyproject.toml file, consider the following:
6766

6867
## What is a pyproject.toml file?
6968

70-
The `pyproject.toml` file is a human and machine-readable file that serves as the primary configuration file for your pure Python package.
69+
The `pyproject.toml` file is a human and machine-readable file that serves as the primary configuration file for your Python package.
7170

72-
The TOML format can be compared to structured formats such as`.json`. However, the TOML format is an easier-to-read format - especially for us humans.
71+
The TOML format can be compared to other structured formats such as`.json`. However, the TOML format was designed to be easier to read for humans.
7372

7473
:::{tip}
7574
[Building your package](build-package) is the step that created the distribution files that are required for you to publish to PyPI.
@@ -148,7 +147,7 @@ In the last lesson, you created a bare-bones pyproject.toml
148147
file that contained the core elements needed to build your
149148
package:
150149

151-
1. A `[build]` table where ou defined your project's backend build tool (`hatchling`)
150+
1. A `[build-system]` table where you defined your project's backend build tool (`hatchling`)
152151
2. A `[project]` table where you defined your project's version and name.
153152

154153
The `pyproject.toml` file that you created, looked like this:
@@ -192,7 +191,7 @@ Let's add the following to your table:
192191
- package **authors**
193192
- package **maintainers**
194193

195-
When you add authors and maintainers you need to use a format that will look like a Python list with a dictionary within it type of format:
194+
When you add authors and maintainers you need to use a format that will look like a Python list with a dictionary within it:
196195

197196
`authors = [{ name = "Firstname lastname", email = "email@pyopensci.org" }]`
198197

@@ -231,7 +230,7 @@ Whereas maintainers are the people that are currently, actively working on the p
231230

232231
A good example of when the lists might diverge is sometimes you have a package where an initial author developed it and then stepped down as a maintainer to move on to other things. This person may continue to be considered an author but no longer actively maintains the package.
233232

234-
It is important to note there that there are many ways define author vs maintainer and we don't prescribe a single approach in this tutorial.
233+
It is important to note that there are many ways to define author vs maintainer and we don't prescribe a single approach in this tutorial.
235234

236235
However, we encourage you to consider carefully, for PyPI publication, who
237236
you want to have listed as authors and maintainers on your PyPI landing page.
@@ -251,7 +250,7 @@ If you do not [use standard classifier values](https://PyPI.org/classifiers/), w
251250
Review that list and add items below to your `pyproject.toml` file:
252251

253252
- development status
254-
- intended audiences,
253+
- intended audiences
255254
- topic
256255
- license and
257256
- programming language support
@@ -286,7 +285,7 @@ dependencies = ["numpy", "requests", "pandas", "pydantic"]
286285
```
287286

288287
:::{admonition} Pin dependencies with caution
289-
Pinnning dependencies references to specifying a specific version of a dependency like this `numpy == 1.0`. In some specific cases, you may chose to pin or specify a lower or upper bound of a specific package. You can do that using syntax like this:
288+
Pinnning dependencies refers to specifying a specific version of a dependency like this `numpy == 1.0`. In some specific cases, you may chose to pin or specify a lower or upper bound of a specific package. You can do that using syntax like this:
290289

291290
`ruamel-yaml>=0.17.21`
292291

@@ -483,8 +482,8 @@ license = { FILE = LICENSE }
483482
## Example `pyproject.toml` files
484483

485484
Below are some examples of `pyproject.toml` files from various packages in the scientific and pyOpenSci ecosystem.
486-
* [PyPAs fully documented pyProject.toml file](https://github.com/pypa/sampleproject/blob/main/pyproject.toml)
487-
* [taxpasta has a nicely organized pyProject.toml file and is a pyOpenSci approved package](https://github.com/taxprofiler/taxpasta/blob/f9f6eea2ae7dd08bb60a53dd49ad77e4cf143573/pyproject.toml)
485+
* [PyPA's fully documented example pyproject.toml file](https://github.com/pypa/sampleproject/blob/main/pyproject.toml)
486+
* [taxpasta has a nicely organized pyproject.toml file and is a pyOpenSci approved package](https://github.com/taxprofiler/taxpasta/blob/f9f6eea2ae7dd08bb60a53dd49ad77e4cf143573/pyproject.toml)
488487

489488

490489
## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
@@ -493,8 +492,8 @@ Below are some examples of `pyproject.toml` files from various packages in the s
493492
At this point you've created:
494493

495494
* A [README.md](add-readme) file for your package
496-
* A [code of conduct](add-coc) to support your user community
497-
* And a [LICENSE](add-license-coc) file which provides legal boundaries around how people can and can't use your software.
495+
* A [CODE_OF_CONDUCT.md](add-coc) file to support your user community
496+
* And a [LICENSE](add-license-coc) file which provides legal boundaries around how people can and can't use your software
498497

499498
You also learned [how to publish your package to (test)PyPI](publish-pypi).
500499

0 commit comments

Comments
 (0)