Skip to content

Commit 6d6a174

Browse files
MarieRoaldyngvem
andcommitted
Update poetry description
Co-authored-by: Yngve Mardal Moe <[email protected]>
1 parent b520fb6 commit 6d6a174

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -389,15 +389,15 @@ is currently undocumented. Thus, we don't recommend using Poetry for more comple
389389
:widths: 20,5,50
390390
:delim: "|"
391391
392-
Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata. _NOTE: currently Poetry adds dependencies using an approach that is slightly out of alignment with current Python peps - however there is a plan to fix this in an upcoming release._ Poetry also allows you to organize dependencies in groups such as documentation, packaging and tests.
392+
Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata.
393393
Dependency specification |✅ |Poetry allows you to be specific about version of dependencies that you add to your package's pyproject.toml file. However, it's default upper bound approach can be problematic for some packages (We suggest you override the default setting when adding dependencies). Read below for more.
394394
Environment management |✅ | Poetry allows you to either use its built in environment or you can select the environment type that you want to use for managing your package. [Read more about its built in environment management options](https://python-poetry.org/docs/basic-usage/#using-your-virtual-environment).
395395
Lock files| ✅ | Poetry creates a **poetry.lock** file that you can use if you need a lock file for your build.
396396
Publish to PyPI and test PyPI|✅|Poetry supports publishing to both test PyPI and PyPI
397397
Version Control based versioning|✅ | The plugin [Poetry dynamic versioning](https://github.com/mtkennerly/poetry-dynamic-versioning) supports versioning using git tags with Poetry.
398398
Version bumping| ✅ | Poetry supports you bumping the version of your package using standard semantic version terms patch; minor; major
399-
Follows current packaging standards|✖✅|Poetry does not quite support current packaging standards for adding metadata to the **pyproject.toml** file but plans to fix this in an upcoming release.
400-
Install your package in editable mode|✅|Poetry supports installing your package in editable mode using `--editable`
399+
Follows current packaging standards|✖✅|Since version 2.0 (released January 2025), Poetry supports most current project metadata standards. However, not all standards are supported, and it also supports the legacy Poetry format. Read below for more.
400+
Install your package in editable mode|✅|Poetry supports installing your package in editable mode.
401401
Build your sdist and wheel distributions|✅|Poetry will build your sdist and wheel distributions using `poetry build`
402402
```
403403

@@ -408,11 +408,11 @@ Build your sdist and wheel distributions|✅|Poetry will build your sdist and wh
408408

409409
Some challenges of Poetry include:
410410

411-
- Poetry, by default, pins dependencies using an "upper bound" limit specified with the `^` symbol by default. However, this behavior can be over-written by specifying the dependency when you use `Poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning.
412-
- _Minor Challenge:_ The way Poetry currently adds metadata to your pyproject.toml file does not follow current Python standards. However, this is going to be addressed with Poetry release version 2.0.
411+
- Poetry has its own concept of grouped dependencies (`poetry add --group=GROUP_NAME DEPENDENCY`). Dependencies added as grouped dependencies are not optional and there is no Python standard for this type of dependency. This should not be confused with "optional" dependencies (`poetry add --optional=GROUP_NAME DEPENDENCY`), which is standardised and lets you group your dependencies into several optional groups.
412+
- While Poetry supports "development" dependencies (i.e. dependencies you use for development but not running the code, such as `pytest`), Poetry does not yet follow the standardised format for specifying such dependencies.
413+
- Poetry, by default, pins dependencies using an "upper bound" limit (which is specified with the `^` symbol in the legacy format). However, this behavior can be over-written by specifying the dependency when you use `Poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning.
413414

414-
Poetry is an excellent tool. Use caution when using it to pin dependencies as
415-
Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option.
415+
Poetry is a popular packaging tool and introduced many very useful features. However, if you decide to use it, then use caution when adding dependencies as Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option.
416416

417417
<!--https://github.com/py-pkgs/py-pkgs/issues/95#issuecomment-1035584750
418418
discusses the slight differences in how poetry adds deps....-->

0 commit comments

Comments
 (0)