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

matplotlib as extra requirement #12

Open
guym0r opened this issue Mar 27, 2022 · 3 comments
Open

matplotlib as extra requirement #12

guym0r opened this issue Mar 27, 2022 · 3 comments

Comments

@guym0r
Copy link

guym0r commented Mar 27, 2022

Hay,

First of all this package is very usefull, tnx!

@luphord did you consider add matplotlib as an extra requirement istead of a regular requirement?
It's required only by the example and this package is big.

In my case I use your package in alpine docker and the time to compile matplotlib is half of the build time.

Tnx!

@luphord
Copy link
Owner

luphord commented Mar 29, 2022

matplotlib is used in the command line interface to allow plotting via the nelson_siegel_svensson plot subcommand. That's why it is included as a dependency in setup.py.

I don't consider this feature "essential", so I am open to moving matplotlib to an extra dependency (probably click should then be treated the same way). @guym0r Would you care to submit a PR?

@guym0r
Copy link
Author

guym0r commented Mar 30, 2022

Yes I would love to :)
But the installation command would change from

pip install nelson-siegel-svensson

to

pip install nelson-siegel-svensson[cli]

in order to run the CLI feature. (the original command will work but witout the CLI feature).
Are you sure you fine with this?

@luphord
Copy link
Owner

luphord commented Mar 31, 2022

I think the docs should make it clear that there are two different "modes" of installation: If you want to use nelson-siegel-svensson as a library, you can go with the ordinary pip install. If you want to use the command line interface, you need the "extras" version.
I am fine with this, but please update the docs (in particular installation.rst and README.rst) accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants