Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Tutorials on Build/Install #7764

Closed
gianfa opened this issue Apr 4, 2023 · 1 comment
Closed

Tutorials on Build/Install #7764

gianfa opened this issue Apr 4, 2023 · 1 comment
Labels
area/docs Documentation issues/improvements kind/feature Feature requests/implementations

Comments

@gianfa
Copy link

gianfa commented Apr 4, 2023

  • [ x] I have searched the issues of this repo and believe that this is not a duplicate.
  • [x ] I have searched the FAQ and general documentation and believe that my question is not already covered.

Feature Request

This is not really a technical feature, as much as it is more of process-related so to speak

Motivation

I use poetry a lot, both for personal projects and for academic and industrial projects (i love the dependency management engine).
However, I often encounter build problems that do not allow me to run simple projects that otherwise work with other package managers. This happens mostly when switching between minors, or sometimes even when switching between patches (breaking semver rules). See an example here: #7691.

This causes some pretty major inconsistencies, Which sometimes impact pipelines and workflows, to the point of making me reconsider using Poetry.

I often read nice explanations of why certain changes are made, in issues. I appreciate this and recognize that there must be a lot of work behind each decision, but all of this remains rather hidden from the user.

Proposal

For the above reasons I propose that a section of the documentation be dedicated to bridging the python software engineering gap for the Poetry user. The tox FAQ goes in that direction.

This could consist of tutorials and/or practical examples to deal with individual typical build/install situations.
An example of sections might be the following:

  1. Little build theory: how to best use build requirements with poetry (perhaps give references to understand)
  2. Use cases:
  • How to deal with an old standard package, like ex no-PEP-517 (this is not very helpful, since it's too hidden and small, but it's something. other examples #3433)
  • How to deal with a package that need to be built locally (see linux case)
  • ...

Expected Outcome

I hope that the application of this proposal or similar, will result in significant time savings on both sides: poetry devs and poetry users; sometimes anticipating or extinguishing the possibility of error due to lack of knowledge that the average user does not have (and in my humble opinion is not due to have most of the time).

Thank you for your great work

@gianfa gianfa added kind/feature Feature requests/implementations status/triage This issue needs to be triaged labels Apr 4, 2023
@dimbleby
Copy link
Contributor

dimbleby commented Apr 4, 2023

much the best way to make docs changes happen is to contribute them.

@Secrus Secrus added area/docs Documentation issues/improvements and removed status/triage This issue needs to be triaged labels Apr 12, 2023
@python-poetry python-poetry locked and limited conversation to collaborators May 11, 2023
@finswimmer finswimmer converted this issue into discussion #7900 May 11, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
area/docs Documentation issues/improvements kind/feature Feature requests/implementations
Projects
None yet
Development

No branches or pull requests

3 participants