Tox: option to display a short documentation with envlist

[gaborbernat]

Currently:

tox -l
py27
pylint
flake8
doc

Would it be possible to also display a short more verbose description for envs? E.g.:

tox -l
py27    run tests against Python 2.7 via pytest with coverage report
pylint   check code style with pylint
flake8  check code style with flake8
doc      generate documentation to build/doc with Sphinx

Thanks!

[obestwalter]

@gaborbernat interesting suggestion.

Just some remarks: it would have to be implemented in a way that it is optional and it would also have to work with generated envs.

[The-Compiler]

Something like this maybe?

[descriptions]
py36 = foo bar
pylint = description here

[gaborbernat]

@obestwalter totally agree. Naturally it can fallback to an empty description (same as we have now). And for the generated envs we probably just need to make possible env variables are usable in description too, not?

[obestwalter]

we probably just need to make possible env variables are usable in description too, not?

Just to make sure, we don't misunderstand: I was not talking ebout environment variables, but about generated environments like described in the link. The names get generated by combining multiple factors together and I don't know how and if to integrate that into what you want to do, so I just mentioned it that it needs to be taken into account.

e.g. if you have:

envlist={py27,py35}-{pylint,tests}

you will have four environments named py27-pylint, py35-pylint, py27-tests, py35-tests - how would you deal with descriptions for things like that?

[The-Compiler]

@obestwalter You could do so with my proposal above. The syntax could even allow for e.g. *-pylint as key.

[hpk42]

@The-Compiler 's example would describe factors and for displaying the description, we'd concatenate all descriptions in the same order as the env name consists of factors.

[asottile]

@The-Compiler I'd suggest [tox-descriptions] to keep it reasonably namespaced (other tools read from tox.ini as well). Definitely like the idea though ++

[gaborbernat]

I will probably try to do this in the next weeks, feel free to assign it to me.

[obestwalter]

Thanks @gaborbernat - this will be in 2.7.0 coming out next friday if nothing bad happens :)