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

Add optional download requirements for dev and plotly express #4644

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

ndrezn
Copy link
Member

@ndrezn ndrezn commented Jun 19, 2024

Closes #2279

This PR adds the ability to install Plotly with:

pip install plotly[pandas]

which bundles pandas in the install, required by plotly.express
and:

pip install plotly[dev]

which installs dev requirements for the package.

This also revises the warning when using plotly.express if pandas is not installed.

Open to ideas on better wording.

(plotly.py) ➜  plotly.py git:(better-pandas-warning) python
Python 3.12.3 (main, Apr  9 2024, 08:09:14) [Clang 15.0.0 (clang-1500.3.9.4)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import plotly.express
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/nathandrezner/Plotly/plotly.py/packages/python/plotly/plotly/express/__init__.py", line 10, in <module>
    raise ImportError(
ImportError: Plotly Express requires pandas to be installed. You can install pandas using pip with:

$ pip install pandas

Or install Plotly Express and its dependencies directly with:

$ pip install "plotly[pandas]"

You can also use Plotly Graph Objects to create a large number of charts without installing
pandas. See examples here: https://plotly.com/python/graph-objects/

@ndrezn
Copy link
Member Author

ndrezn commented Jun 19, 2024

We can plausibly drop the note about graph objects but basically I want some sort of explanation of why pandas isn't a dependency.

@emilykl
Copy link
Contributor

emilykl commented Jun 19, 2024

We shouldn't recommend pip install plotly.express , I believe it only exists for backwards compatibility and it's confusing to have multiple install paths.

If we want to have a one-liner "install everything" command that should be a change made inside Plotly.py.

@ndrezn
Copy link
Member Author

ndrezn commented Jun 19, 2024

I was thinking of adding:

pip install plotly[express]

as an option which goes with usual pip patterns for optional dependencies. If we went that route I would expect that we drop support for pip install plotly.express entirely.

Copy link
Contributor

@gvwilson gvwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed from the PR title that this was going to improve the install-time or runtime error messages for "you need Pandas" but there seem to be other changes as well? I trust you...

.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@@ -137,17 +137,17 @@ conda activate plotly-dev

### Install requirements - (Non-Windows)
```bash
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/requires-install.txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these related to the pandas warning change?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is related to the updates to requirements files.

contributing.md Show resolved Hide resolved
contributing.md Show resolved Hide resolved
@ndrezn
Copy link
Member Author

ndrezn commented Jun 19, 2024

@gvwilson there are other changes following @emilykl 's comment. It might make sense to break this into two PRs to be honest...

@ndrezn ndrezn changed the title Improve no pandas warning Add optional download requirements for dev and plotly express Jun 19, 2024
@gvwilson
Copy link
Contributor

👍 on breaking the PR - thank you

@emilykl
Copy link
Contributor

emilykl commented Jun 19, 2024

IMO the naming should be plotly[pandas] rather than plotly[express] -- much more clear what it's actually doing.

I'm in favor of this change, but let's not merge it right away. This PR changes a number of lines in setup.py so it's not just an addition; it could feasibly break the install process for some users. Need to do really solid QA to make sure it runs smoothly.

@ndrezn
Copy link
Member Author

ndrezn commented Jun 19, 2024

@gvwilson on further thought I think it makes sense to keep these changes in one PR. The text in the warning message is directly related to the installation recommendations that are also added in this PR -- I've updated the title & description to make the primary change more clear.

@ndrezn ndrezn requested a review from alexcjohnson June 19, 2024 21:35
@gvwilson
Copy link
Contributor

👍

@ndrezn
Copy link
Member Author

ndrezn commented Jul 29, 2024

@emilykl is this PR good to go with the latest changes?

@gvwilson gvwilson removed their assignment Aug 2, 2024
@gvwilson gvwilson added feature something new P2 needed for current cycle infrastructure build process etc. labels Aug 13, 2024
@ndrezn
Copy link
Member Author

ndrezn commented Oct 9, 2024

@marthacryan could you take a look at this?

@gvwilson
Copy link
Contributor

gvwilson commented Oct 9, 2024

See also #4790

@marthacryan
Copy link
Collaborator

@ndrezn So is pip install plotly[pandas] exactly the same as pip install pandas?

@emilykl
Copy link
Contributor

emilykl commented Oct 15, 2024

@marthacryan pip install plotly[pandas] would be roughly equivalent to pip install plotly && pip install pandas I believe.

@marthacryan
Copy link
Collaborator

Oh interesting. What is the benefit here over just using pip install plotly pandas?

@ndrezn
Copy link
Member Author

ndrezn commented Oct 15, 2024

The benefit is we recommend a specific version number for compatibility. I don't think we have issues with different versions of Pandas but this makes it easy to pin a version of Pandas for use with Plotly if we ever encounter issues.

In fact we're doing that here, where we install the latest pandas for new versions of Python but force older pandas for older Python. People in the original issue were having funky errors caused by this incompatibility: #2279 (comment)

@gvwilson
Copy link
Contributor

conversation with @ndrezn he believes this should go in before #4790 (Narwhals support) so moving it to the 3.0 release cycle.

@marthacryan
Copy link
Collaborator

The benefit is we recommend a specific version number for compatibility. I don't think we have issues with different versions of Pandas but this makes it easy to pin a version of Pandas for use with Plotly if we ever encounter issues.

In fact we're doing that here, where we install the latest pandas for new versions of Python but force older pandas for older Python. People in the original issue were having funky errors caused by this incompatibility: #2279 (comment)

Oh ok that makes sense! Maybe for documenting the usage of that we could make that more clear?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature something new infrastructure build process etc. P2 needed for current cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Requires pandas, but not documented?
5 participants