Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pyproject_config.rst: Remove beta tag for (optional) dependencies #3632

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EwoutH
Copy link

@EwoutH EwoutH commented Oct 10, 2022

Remove the beta tag for dependencies and optional dependencies in the Configuring setuptools using pyproject.toml files documentation.

Remove the beta tag for dependencies and optional dependencies in the "Configuring setuptools using pyproject.toml files" documentation.
@abravalheri
Copy link
Contributor

abravalheri commented Oct 10, 2022

I think we can postpone this for a while since we haven't received a lot of feedback yet about using requirements.txt files for dependencies.

So far, the only feedback we received is of people trying to use pip options like --editable, --index-url, --find-links and being surprised with the errors (this is explicitly documented as not supported). My understanding is that people are having trouble to interpret the feature and that it is confusing (so we might consider removing it in the future).

@EwoutH
Copy link
Author

EwoutH commented Oct 13, 2022

@abravalheri I was looking into packaging / Data Files Support in pyproject.toml, have you got community feedback on that? And if so, would you say that is still in beta yet?

@abravalheri
Copy link
Contributor

abravalheri commented Oct 13, 2022

Hi @EwoutH, in general, the opportunity of moving to pyproject.toml is seen as achance of reimagining some complicated/problematic configuration since it does not require backwards compatibility with setup.cfg. The configurations for include-package-data, exclude-package-data and package-data are recurrently mentioned as candidates for this new hypothetical mechanism. However, I haven't been in contact yet with feasible/well-founded a design proposal/implementation plan. That is the basis of the "not enough feedback" argument.

On the other hand, simple projects should not really need to resort to these configurations: as long as the devs use a well thought directory structure maintaining the relevant files inside the package directory and use a proper MANIFEST.in or a VCS plugin like setuptools-scm, the wheel distribution will end up fine...

@bunny-therapist
Copy link

I think we can postpone this for a while since we haven't received a lot of feedback yet about using requirements.txt files for dependencies.

So far, the only feedback we received is of people trying to use pip options like --editable, --index-url, --find-links and being surprised with the errors (this is explicitly documented as not supported). My understanding is that people are having trouble to interpret the feature and that it is confusing (so we might consider removing it in the future).

I am currently using "file = requirements.txt" in pyproject.toml and I was considering using it in a lot more projects in our group, but I have put that on hold because of the beta warning. I don't want to risk making all our projects depend on something that later gets removed. (We have projects which currently open requirements.txt files and reads them, programmatically, inside of setup.py, and I wanted to replace this with just linking requirements.txt in pyproject.toml.) Not sure if this is the right place to provide feedback (probably not - I apologize); I found this PR while trying to figure out exactly how "beta" this feature is and if it was likely to be kep.

@bkane-msft
Copy link

I'm using the following block in my pyproject.toml for a learning project:

[tool.setuptools.packages.find]
where = ["."]
include = ["simple_python_package*"]
exclude = ["simple_python_package.tests*", "simple_python_package.scripts*"]
namespaces = false

Is this the correct usage? If so, is there any kind of schedule for stabilization?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants