Option to get description from module __doc__

[Carreau]

I more and more find myself as wanting the same description from the readme.md/description.md and the __doc__ of my main module.

Would you have any objection to an alternative to description-file that would get the description from the module __doc__.

I (of course) could globals()['__doc__'] = open('../readme.md').read() but that seem ugly.

Thoughts ?

[takluyver]

This is at 'needs thinking about' for me at the moment. I understand the urge, but I don't want to weigh flit down with a thousand different options.

I more and more find myself as wanting the same description from the readme.md/description.md and the __doc__ of my main module.

I like to have info in the Readme because Github highlights it. Would you leave the Github repository without a Readme, have a minimal Readme with less info than the full description, or duplicate it all in the Readme anyway?

I (of course) could globals()['__doc__'] = open('../readme.md').read() but that seem ugly.

Yeah, don't do that. For one thing, I don't like code doing stuff on import. For another, it's not going to work once your module is installed.