You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorials/intro.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ The core elements of Python package include:
92
92
-**License:** An open source license …. - link to choose a license…
93
93
-**Infrastructure** that automates updates, publication workflows and runs test suites
94
94
95
-
If you intend for others to use and contribute to your code, consider who will maintain it over time. You will want a **contributing / development** guide to help new potential contributors get started with contributing to your package. And a **code of conduct** to ensure community interactions remain healthy both for you and your contributors / maintainer team
95
+
If you intend for others to use and contribute to your code, consider who will maintain it over time. You will want a **contributing / development** guide to help new potential contributors get started with contributing to your package, as well as a **code of conduct** to ensure community interactions remain healthy both for you and your contributors / maintainer team
96
96
97
97
:::{admonition} What pyOpenSci looks for in a package
98
98
:class: tip
@@ -120,7 +120,7 @@ By publishing your package on GitHub or GitLab, you are now making your code pub
120
120
:::{admonition} GitHub & GitLab vs. Git
121
121
:class: tip
122
122
123
-
GitHub and GitLab are online (cloud) platforms that run git (version control
123
+
GitHub and GitLab are online (cloud) platforms that run `git` (version control
124
124
software) on the backend. Running git locally on your computer allows you to
125
125
upload (`git push`) and download (`git pull`) files to GitHub and GitLab.
126
126
:::
@@ -196,7 +196,7 @@ data, and analyses used in a study.
196
196
197
197
A Python package however is a collection of modules that are focused on a
198
198
specific set of tasks that can be applied across numerous research projects.
199
-
As such a Python package is more generalizable than a research Compendium
199
+
As such a Python package is more generalizable than a Research Compendium
200
200
which supports a specific project.
201
201
202
202
:::
@@ -217,7 +217,7 @@ You don't have to publish to PyPI in order to make your code installable.
217
217
WIth the correct file structure and project metadata you can make your code
218
218
installable locally on your computer and use it for projects that you are working
219
219
on without having to ever publish to PyPI. Publishing to PyPI is useful when you
220
-
want to make your code publicfacing and share it with others.
220
+
want to make your code public-facing and share it with others.
221
221
:::
222
222
223
223
### Publishing a package
@@ -228,7 +228,7 @@ pure python package, then publishing to both PyPI and conda-forge only takes jus
228
228
229
229
In these tutorials, you will learn [how to publish to PyPI using twine.](6-publish-pypi.md)
230
230
231
-
Then you can create a conda-forge recipe using the grayskull tool. This recipe can then be submitted to conda-forge. [You will learn more about the conda-forge publication process here.](7-publish-conda-forge.md)
231
+
Then you can create a conda-forge recipe using the [grayskull](https://github.com/conda/grayskull) tool. This recipe can then be submitted to conda-forge. [You will learn more about the conda-forge publication process here.](7-publish-conda-forge.md)
0 commit comments