Update the setup details to work with pip #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The symlink in the doxygen tool example interferes with installing using pip because it tries to do a recursive installation.
The more modern configuration for projects is to follow the [PEP-517] and place most of the details in the pyproject.toml and setup.cfg. To preserve pre-517 builds, we retain the setup.py with an empty call to setup(). [PEP-517]: https://www.python.org/dev/peps/pep-0517
Installation using pip requires SCons 4 or newer. That means documentation is necessary. The other concern is scons-contrib is not on pypi.org. Instead, we point users to the VCS version of the command.
bdbaddog
reviewed
Jul 7, 2021
| .. note:: Installs using pip or setup.py are not presently implemented. | ||
| Suggest manually add a tool to ``site_scons/site_tools`` to use. | ||
| .. note:: Installs using pip searching pypi.org are not presently | ||
| implemented. For alternative options, see the installation |
There was a problem hiding this comment.
Not sure why you removed the note that site_scons/site_tools was a reasonable install location. I'll re-add post merge.
There was a problem hiding this comment.
I was thinking that pointing to the Installation section was sufficient since those updates should layout all the options.
There was a problem hiding this comment.
I figure always easier to provide info at point of use.
A great deal of users never read the docs, or enough of the docs for what they're trying to do.
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the setup.cfg and setup.py to work with
pipto install the project. It also adds the pyproject.toml necessary for [PEP-517] installation. This also updates the installation instructions to use the VCS version of thepip installcommand since scons-contrib is not listed on PyPI.This partially addresses #3.
[PEP-517]: https://www.python.org/dev/peps/pep-0517/