[review-round-2 - Jan 3 merge] What is a Python package intro tutorial? #139
Conversation
lwasser
force-pushed
the
bb-dec23-intro-2
branch
from
32fa5d5 to
4f88f9d
Compare
There was a problem hiding this comment.
I think the more logical order, which the guide takes, is:
- what is a package?
- make code installable
- add README
- add metadata
- publish to pypi
- publish to conda
There was a problem hiding this comment.
@ucodery that is definitely the order we had before. i'm so torn. the reason why i thought about moving publish to pypi up further was an early win for users. i keep changing my mind because the order that you suggest /that we had previously is how you'd actual go about creating a packaging logically. i'll revert to what we originally planned for now and we can always teach things out of order if we want to (or not)
There was a problem hiding this comment.
I just found it very strange that adding metadata was so late on the list as you can't actually publish to pypi without some metadata (or even locally install).
There was a problem hiding this comment.
i totally understand. let's revisit / chat in slack a bit. i have all of the lessons ready to push for review but want to get the tests pr and the installable code pr done first!! they do add some metadata (enough for a local install) in lesson 2. BUT as you point out if they don't have a readme or metadata in their pyproj.toml then the pypi landing page will look ugly.
i'll post about this in slack so we can discuss! your point is totally valid!! there is the learner side however and early wins that may also be important to consider!
| You can think about a package as a toolbox filled with coding tools. | ||
| A tool may be a function or a class. Each tool does a specific thing | ||
| well. |
There was a problem hiding this comment.
This is just repeating the last sentence.
| You can think about a package as a toolbox filled with coding tools. | |
| A tool may be a function or a class. Each tool does a specific thing | |
| well. |
Co-authored-by: Jesse Mostipak <[email protected]> Apply suggestions from code review Co-authored-by: William F. Broderick <[email protected]>
Co-authored-by: Jesse Mostipak <[email protected]> Update index.md Co-authored-by: Jesse Mostipak <[email protected]>
Co-authored-by: Jesse Mostipak <[email protected]> Apply suggestions from code review Co-authored-by: Jesse Mostipak <[email protected]>
Co-authored-by: David Nicholson <[email protected]>
Co-authored-by: William F. Broderick <[email protected]>
Final alt tags and cleanup
Co-authored-by: Jeremy Paige <[email protected]>
Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]> Update tutorials/intro.md Co-authored-by: Jeremy Paige <[email protected]>
Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]> Fix: edit from @billbrod Co-authored-by: William F. Broderick <[email protected]>
lwasser
force-pushed
the
bb-dec23-intro-2
branch
from
3dbf627 to
c023c6c
Compare
|
ok y'all!! Our FIRST packaging lessons is being merged now!! I'm SOOOO appreciative of all of your input on this!! yahoo!! this is a big first step for us! |
This pr build on top of #117 . let's do a final round of review before merging in early January!! yahoo!!