question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs issue: `setup_requires` is explained as problematic in cookbook, but no comparable replacement appears to be given

See original GitHub issue

https://pip.readthedocs.io/en/1.4.1/cookbook.html#controlling-setup-requires

This section and various other sources (like https://github.com/cython/cython/issues/2730#issuecomment-473716573 and other helpful comments) say that setup_requires has issues due to its reliance on easy_install and should be avoided.

However, the above cookbook section doesn’t actually appear to offer any alternative! I think if you want people to stop using it, this section should really show one. All it appears to do is to show how to work around the package index options not working while still using setup_requires, or am I misunderstanding this section completely?

It would be incredibly helpful if that cookbook section could be expanded to add a demonstration of a full example of a modern setup_requires-equivalent, how it should be done if one wants to avoid deprecated functionality. (or if that is already somewhere else in the cookbook, maybe it would be wise to add a link/reference here?) Because it’s not obvious at all to me how to do it 😕

PS: you’re doing great work this is just a minor bump I found worth reporting!

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:1
  • Comments:18 (9 by maintainers)

github_iconTop GitHub Comments

2reactions
pradyunsgcommented, Mar 26, 2019

Documentation PRs to clarify would be welcome.

2reactions
uranusjrcommented, Mar 24, 2019

@JonasT setupmeta is a tool that auto-generates some setup.py content (I know it’s not entirely accurate, but let’s keep things simple). It is not essential to packaging, thus not mentioned in docs.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Are Recipes and Cookbooks Protected by Copyright
Recipes can be protected under copyright law if they are accompanied by “substantial literary expression.” This expression can be an explanation ...
Read more >
Why can't chef resolve my cookbooks? - Stack Overflow
The problem I am able to create the cookbook and run it, but I am not able to reference dependencies from supermarket. I...
Read more >
2. Writing the Setup Script — Python 3.11.1 documentation
The setup script is the centre of all activity in building, distributing, and installing modules using the Distutils. The main purpose of the...
Read more >
The Why of Cooking - The Atlantic
But recipes, for all their precision and completeness, are poor teachers. ... Short of enrolling in a cooking school, is there not a...
Read more >
hassio letsencrypt
I am not sure how to create it and how to place this in folder as I am unable ... the Let's Encrypt...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found