Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
db390c8
Rebase 1
lwasser Feb 2, 2023
47ca25a
Fix: edits to package guide from review
lwasser Feb 2, 2023
e114a1b
Fix: cleanup packaging page and add decision tree diagram
lwasser Feb 16, 2023
4db3074
Add: more edits from massive pr
lwasser Feb 17, 2023
9cae7fa
Fix: final edits to packaging section broken links etc
lwasser Feb 22, 2023
3c6f7ff
Update index.md
lwasser Mar 13, 2023
9be2c29
Apply suggestions from code review
lwasser Mar 13, 2023
f657772
Apply suggestions from code review
lwasser Mar 13, 2023
cf36261
Apply suggestions from code review
lwasser Mar 13, 2023
755cdd5
Apply suggestions from code review
lwasser Mar 13, 2023
3e78288
Fix: Apply suggestions from code review
lwasser Mar 13, 2023
0c4b77c
Fix: confpy file
lwasser Mar 13, 2023
0a9cf7a
Fix: clean up some of the discussion around poetry
lwasser Mar 13, 2023
659ffeb
Updated decision tree diagram
lwasser Mar 13, 2023
61b86eb
Update package-structure-code/python-package-structure.md
lwasser Mar 13, 2023
4b80f31
Update package-structure-code/complex-python-package-builds.md
lwasser Mar 15, 2023
7ba8292
Update package-structure-code/intro.md
lwasser Mar 15, 2023
b64b59a
Fix: many more comments from review 2
lwasser Mar 15, 2023
40eb8c6
A few more fixes to the build tools page
lwasser Mar 15, 2023
1cbae63
Update package-structure-code/complex-python-package-builds.md
lwasser Mar 16, 2023
fbf3ded
Update package-structure-code/python-package-distribution-files-sdist…
lwasser Mar 16, 2023
b082fb1
Fix: csv table delim and numerous other review fixes
lwasser Mar 16, 2023
f2c1966
Fix: remove notes from docs
lwasser Mar 16, 2023
4a75fd9
Update package-structure-code/python-package-build-tools.md
lwasser Mar 16, 2023
e46dab2
Update package-structure-code/python-package-distribution-files-sdist…
lwasser Mar 16, 2023
68f5723
Update package-structure-code/python-package-distribution-files-sdist…
lwasser Mar 16, 2023
bef6801
Fix: many more great comments to address
lwasser Mar 16, 2023
a28b971
Fix: more edits from the current review
lwasser Mar 20, 2023
45b7ff8
Add: new cleaned up diagram
lwasser Mar 21, 2023
d427e08
Fix: clarify the section on adding tests to src layout
lwasser Mar 21, 2023
5c74e82
Cleanup of package structure page
lwasser Mar 22, 2023
6d1cd13
Final edits?! yaas
lwasser Mar 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix: Apply suggestions from code review
Apply suggestions from code review

Update package-structure-code/python-package-build-tools.md

Co-authored-by: Randy Döring <[email protected]>

Update package-structure-code/python-package-build-tools.md

Co-authored-by: Randy Döring <[email protected]>

Update package-structure-code/python-package-build-tools.md

Co-authored-by: Randy Döring <[email protected]>

Update package-structure-code/python-package-distribution-files-sdist-wheel.md

Co-authored-by: David Nicholson <[email protected]>
  • Loading branch information
lwasser and NickleDave committed Mar 13, 2023
commit 3e782887948c681716156fc14ca49c2b60741b6f
8 changes: 4 additions & 4 deletions package-structure-code/python-package-build-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Poetry is user-friendly and has clean and easy-to-read documentation.

```{note}
While some have used Poetry for Python builds with C/C++ extensions, this support
is currently undocumented. Thus we don't recommend it for more complex builds.
is currently undocumented. Thus, we don't recommend using Poetry for more complex builds.
```

### Poetry features
Expand All @@ -421,8 +421,8 @@ Build your SDist and wheel distributions,✅,

Some challenges of Poetry include:

* Poetry pins dependencies using an "upper bound" limit specified with the `^` symbol. See breakout below for more regarding why this is potentially problematic.
* Doesn't support version control based versioning
* Poetry pins dependencies using an "upper bound" limit specified with the `^` symbol by default. See breakout below for more regarding why this is potentially problematic.
* Doesn't support version control based versioning without a plugin
* *Minor:* The way Poetry currently adds metadata to your pyproject.toml file does not does not follow current Python standards. However, this is going to be addressed when they release version 2.0.

Poetry is an excellent tool. Use caution when pinning dependencies as
Expand All @@ -434,7 +434,7 @@ discusses the slight differences in how poetry adds deps....-->
```{admonition} Challenges with Poetry dependency pinning
:class: important

Poetry pins dependencies using `^`. This `^` symbol means that there is
Poetry pins dependencies using `^` by default. This `^` symbol means that there is
an "upper bound" to the dependency. Thus poetry will bump a dependency
version to a new major version. Thus, if your package uses a dependency that
is at version 1.2.3, Poetry will never bump the dependency to 2.0 even if
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

There are two core distribution files
that you need to create to publish your Python package to
PyPI SDist and Wheel. The SDist (Source Distribution) contains the raw source
PyPI source distribution (often called an sdist) and wheel. The SDist contains the raw source
code for your package. The Wheel (.whl) contains the built / compiled files
that can be directly installed onto anyones' computer.

Expand Down