[dec 12 merge] fix: add cross links to the packaging guide #431
+98
−59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lwasser
changed the title
|
pinging @pyOpenSci/packaging-council on this pr for review (if you have time). |
hugovk
reviewed
Dec 5, 2024
|
|
||
| We do not recommend including tests as part of your package wheel by default. However, not including tests in your package distribution will make it harder for people other than yourself to test whether your package is functioning correctly on their system. If you have a small test suite (Python files + data), and think your users may want to run tests locally on their systems, you can include tests by moving the `tests/` directory into the **src/package** directory (see example below). | ||
| Writing [tests](/tests/index.html) for your package is important; however, we do not recommend including tests as part of your [package wheel](python-wheel) by default. However, not including tests in your package distribution will make it harder for people other than yourself to test whether your package runs properly on their system. If you have a small test suite (Python files + data), and think your users may want to run tests locally on their systems, you can include tests by moving the `tests/` directory into the **src/package** directory (see example below). |
There was a problem hiding this comment.
Hmm, the CI can't find /tests/index.html:
https://github.com/pyOpenSci/python-package-guide/actions/runs/12185280544/job/33991144890?pr=431#step:9:131
There was a problem hiding this comment.
thank you for catching all of these issues!! CI is now happy thanks to you!!
| discourage you from including data in your test suite directory. Rather, | ||
| host your test data in a repository such as Figshare or Zenodo. Use a | ||
| tool such as [Pooch](https://www.fatiando.org/pooch/latest/) to access | ||
| the data when you (or a user) runs tests. | ||
|
|
||
| Check out the testing section of our guide for more information about tests. | ||
| For more information about Python package tests, see the [tests section of our guide](/tests/index.html). |
There was a problem hiding this comment.
Comment on lines
161
to
162
| distribution files. This places a maintenance toll on repositories like PyPI and | ||
| Anaconda.org that have to deal with thousands of package uploads. | ||
| Anaconda.org has to deal with thousands of package uploads. |
There was a problem hiding this comment.
It read better before with "that have" than "has".
Co-authored-by: Hugo van Kemenade <[email protected]>
|
Let's see if CI is happier now. docs-test ran successfully locally after the suggested changes!! 🚀 🤞🏻 |
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
lwasser
commented
Dec 11, 2024
Co-authored-by: Hugo van Kemenade <[email protected]>
|
thank you @hugovk, for the great review!! I've integrated all of your changes and will merge later this evening (assuming CI is still happy!!) 🚀 |
ucodery
reviewed
Dec 11, 2024
package-structure-code/python-package-distribution-files-sdist-wheel.md
Outdated
Show resolved
Hide resolved
| - **docs/:** discussed in our docs chapter, this directory contains your user-facing documentation website. In a **src/** layout docs/ are normally included at the same directory level of the **src/** folder. | ||
| - **tests/** this directory contains the tests for your project code. In a **src/** layout tests are normally included at the same directory level of the **src/** folder. | ||
| - **docs/:** discussed in our docs chapter, this directory contains your user-facing documentation website. In a **src/** layout docs/ are normally included at the same directory level as the **src/** folder. | ||
| - **tests/** This directory contains the tests for your project code. In a **src/** layout, tests are normally included at the same directory level as the **src/** folder. |
There was a problem hiding this comment.
You capitalized this bullet, but no others. Not sure what your preference is.
There was a problem hiding this comment.
this happens because i never know when to capitalize and when to not capitalize! let's capitalize?
lwasser
commented
Dec 12, 2024
Co-authored-by: Jeremiah Paige <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the start of a set of small pr's that cross link to other content in our guidebook. This is also a good opportunity for us to identify things that we might want to add, change, or enhance.
Finally, I noticed that our language was a bit too "gentle" and suggestive vs being definitive. I think we can be definite and confident now that we've been taught this stuff numerous times!