pipenv.el icon indicating copy to clipboard operation
pipenv.el copied to clipboard

Documenting installing dev packages

Open valignatev opened this issue 6 years ago • 3 comments

Hi, a nice package you have here :) I didn't find an intended way of installing dev-packages, but from observing the source code I was able to do it this way:

M-x pipenv-install
# it asks then
Which Python packages should be installed (separate with space)?

And then I provide --dev package1 package2 ... packageN, which works just fine, packages appear in the [dev-packages] section.

The question is - did you intended to allow this, or it's an accidental side effect of how things are implemented?

If it's intended (or if it's not, but you think it's ok to do it this way) - we should document that it's possible to pass additional args this way.

Cheers!

valignatev avatar Jun 03 '18 13:06 valignatev

Hi @valignatev

The question is - did you intended to allow this, or it's an accidental side effect of how things are implemented?

This is a side effect of the way it is implemented. The library probably needs a nice way to prompt the user for optional flags when a function is called interactively.

What behaviour would you like on this at the interactive prompt?

pwalsh avatar Jun 03 '18 13:06 pwalsh

From the top of my head, I would say that separate pipenv-install and pipenv-install-dev would be nice. The main reason for this is that we don't often install dev packages, and second prompt of "would you like to add it to dev dependency" will become a burden for the user. Although this side effect could be handy if I typed pipenv-install already, and then changed my mind :)

In a nutshell, I'm for separate commands for this, or for allowing (and documenting) --dev.

There is a third way - magit way, e.g. separate ui for pipenv with ? command and togglable options. But I think it's an overkill for pipenv which has a tiny api comparing to git.

Does it make sense to you? What do you think?

valignatev avatar Jun 03 '18 14:06 valignatev

https://github.com/pwalsh/pipenv.el/issues/45

pwalsh avatar Dec 06 '18 16:12 pwalsh