Add extras_require to setup.py for optional dependencies by aaronayres35 · Pull Request #257 · enthought/apptools

aaronayres35 · 2020-12-10T20:44:39Z

fixes #176

This PR adds to the extras_require section in setup.py to include additional optional dependencies. It also mentions these in the readme so they are more apparent (Should I add instructions saying to run pip install apptools[h5] for examples? I thought that might be overkill, but was unsure).

Note in this PR when looking for any optional dependencies I saw io imports listed as third party imports, so I moved those to be with standard library imports

Checklist

Add a news fragment if this PR is news-worthy for end users. (see docs/releases/README.rst)

kitchoi

(Should I add instructions saying to run pip install apptools[h5] for examples? I thought that might be overkill, but was unsure)

Not an overkill, I actually think it is good to provide straightforward installation instructions that end users can copy and paste, instead of having to parse the package links and come up with the command themselves.
e.g. https://github.com/enthought/pyface#installation

(I am guessing this wasn't done in the past because pip wasn't as feature rich then?)

kitchoi · 2020-12-11T10:22:23Z

And this probably deserves a news fragment :)
Looks like we need a new category for this too, maybe build?

kitchoi · 2020-12-11T10:44:41Z

Looks like we need a new category for this too, maybe build?

See #261
If the name of "build" sounds good to you, the file can be added here regardless of whether that PR or this PR is merged first. If #261 is not backported to the maintenance branch, then we will see the leftover news fragments being detected when the changelog is built again prior to the final release... but it is probably most convenient to backport the change in #261.

…in install_requires too)

kitchoi

LGTM. Thank you.
Shall we have a news fragment for this change? #261 is motivated by this PR, but I thought I should confirm with you first before merging it.

aaronayres35 · 2020-12-11T14:41:57Z

LGTM. Thank you.
Shall we have a news fragment for this change? #261 is motivated by this PR, but I thought I should confirm with you first before merging it.

I've added one in the latest commit, I just used the build name before 261 was merged.

But yes, I like the addition of #261, thank you!

kitchoi

I've added one in the latest commit, I just used the build name before 261 was merged.

Oops. I am sorry. I failed refresh the tab 🤦

kitchoi · 2020-12-11T14:55:28Z

@@ -0,0 +1 @@
+Add extras_require to setup.py for optional dependencies


You will need (#257) at the end.

* add optional dependencies for specific cub packages to extras_require * add details to README about optional dependencies * list io imports as standard library imports * add prefrences/configobj to extras_rrequire as well (leave configobj in install_requires too) * add specific install instructions * formatting * remove unneeded back ticks * move install instructions into a separate section * add news fragment * add PR number to news fragment

* Make sure optional dependencies are optional for tests (#260) * make sure optional dependencies are optional for tests * add a news fragment * apply suggestion from code review * Add extras_require to setup.py for optional dependencies (#257) * add optional dependencies for specific cub packages to extras_require * add details to README about optional dependencies * list io imports as standard library imports * add prefrences/configobj to extras_rrequire as well (leave configobj in install_requires too) * add specific install instructions * formatting * remove unneeded back ticks * move install instructions into a separate section * add news fragment * add PR number to news fragment * Remove image license files (#262) * remove image license files * move internal image license file to root directory * add image_LICENSE_CP.txt and include it in manifest * Apply suggestions from code review Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com> Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com> * Add a new category for build system related changes (#261) * update changelog Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com> Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>

aaronayres35 added 3 commits December 10, 2020 14:26

add optional dependencies for specific cub packages to extras_require

a79649a

add details to README about optional dependencies

245cc12

list io imports as standard library imports

8afe2a1

aaronayres35 commented Dec 10, 2020

View reviewed changes

Comment thread setup.py

kitchoi reviewed Dec 11, 2020

View reviewed changes

Comment thread setup.py

kitchoi mentioned this pull request Dec 11, 2020

Add a new category for build system related changes #261

Merged

aaronayres35 added 4 commits December 11, 2020 07:46

add prefrences/configobj to extras_rrequire as well (leave configobj …

0d389f7

…in install_requires too)

add specific install instructions

4d6051b

formatting

bac835d

remove unneeded back ticks

a52c2dd

kitchoi reviewed Dec 11, 2020

View reviewed changes

Comment thread README.rst Outdated

aaronayres35 added 2 commits December 11, 2020 08:11

move install instructions into a separate section

1f17dd0

add news fragment

ae0f756

kitchoi reviewed Dec 11, 2020

View reviewed changes

kitchoi approved these changes Dec 11, 2020

View reviewed changes

kitchoi reviewed Dec 11, 2020

View reviewed changes

add PR number to news fragment

6a4b1a3

aaronayres35 merged commit b6d1311 into master Dec 11, 2020

aaronayres35 deleted the add-extras_require branch December 11, 2020 15:07

aaronayres35 added the need backport to 5.0 PRs that need to be backported to maint/5.0 label Dec 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add extras_require to setup.py for optional dependencies#257

Add extras_require to setup.py for optional dependencies#257
aaronayres35 merged 10 commits into
masterfrom
add-extras_require

aaronayres35 commented Dec 10, 2020 •

edited

Loading

Uh oh!

Uh oh!

kitchoi left a comment

Uh oh!

Uh oh!

kitchoi commented Dec 11, 2020

Uh oh!

kitchoi commented Dec 11, 2020

Uh oh!

Uh oh!

kitchoi left a comment

Uh oh!

aaronayres35 commented Dec 11, 2020 •

edited

Loading

Uh oh!

kitchoi left a comment

Uh oh!

kitchoi Dec 11, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1 @@
		Add extras_require to setup.py for optional dependencies No newline at end of file

Conversation

aaronayres35 commented Dec 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

kitchoi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kitchoi commented Dec 11, 2020

Uh oh!

kitchoi commented Dec 11, 2020

Uh oh!

Uh oh!

kitchoi left a comment

Choose a reason for hiding this comment

Uh oh!

aaronayres35 commented Dec 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kitchoi left a comment

Choose a reason for hiding this comment

Uh oh!

kitchoi Dec 11, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aaronayres35 commented Dec 10, 2020 •

edited

Loading

aaronayres35 commented Dec 11, 2020 •

edited

Loading