[Distutils] Re: org-mode README file formats

2018-05-09 Thread Wes Turner
Pypa/readme is what Warehouse uses to render rst and markdown long_descriptions to safe HTML. https://github.com/pypa/readme_renderer There are a number of org-mode implementations; even for a few for Vim and Sublime. https://en.m.wikipedia.org/wiki/Org-mode#Integration ``conda install pandoc``

[Distutils] Re: org-mode README file formats

2018-05-09 Thread Thomas Kluyver
On Wed, May 9, 2018, at 7:22 PM, Diane Trout wrote: > Does the warehouse actually read the readme file directly? or does it > preferentially look at long_description metadata? I think it only looks at the long_description metadata; as far as I know README is just another file in the archive. If

[Distutils] Re: org-mode README file formats

2018-05-09 Thread Diane Trout
On Tue, 2018-05-08 at 19:32 -0300, Leonardo Rochael Almeida wrote: > Maybe you can use pandoc as a `setup_depends` and convert it to an > acceptable format at build time? > I had been wondering how the readme's get used by setuptools. Does the warehouse actually read the readme file directly?

[Distutils] Re: org-mode README file formats

2018-05-08 Thread Leonardo Rochael Almeida
On 8 May 2018 at 15:00, Diane Trout wrote: > On Tue, 2018-05-08 at 16:44 +, Brett Cannon wrote: > > > > On Mon, 7 May 2018 at 16:54 Diane Trout wrote: > > Hi, > > I was building a package where I had a README.org file, which > setuptools couldn't find. > > It

[Distutils] Re: org-mode README file formats

2018-05-08 Thread Thomas Kluyver
On Tue, May 8, 2018, at 5:44 PM, Brett Cannon wrote: > If it is an Emacs thing then I would vote "no" since that's very editor- > specific and I suspect trying to support every plaintext file format > is never-ending. Currently the metadata spec defines the permitted mimetypes. Maybe we should

[Distutils] Re: org-mode README file formats

2018-05-08 Thread Alex Walters
: [Distutils] Re: org-mode README file formats On Tue, 8 May 2018 at 11:00 Diane Trout <di...@ghic.org <mailto:di...@ghic.org> > wrote: On Tue, 2018-05-08 at 16:44 +, Brett Cannon wrote: On Mon, 7 May 2018 at 16:54 Diane Trout <di...@ghic.org <mailto:di.

[Distutils] Re: org-mode README file formats

2018-05-08 Thread Diane Trout
On Tue, 2018-05-08 at 16:44 +, Brett Cannon wrote: > On Mon, 7 May 2018 at 16:54 Diane Trout wrote: > > Hi, > > > > > > > > I was building a package where I had a README.org file, which > > > > setuptools couldn't find. > > > > > > > > It listed .md as a valid format,

[Distutils] Re: org-mode README file formats

2018-05-08 Thread Brett Cannon
On Mon, 7 May 2018 at 16:54 Diane Trout wrote: > Hi, > > I was building a package where I had a README.org file, which > setuptools couldn't find. > > It listed .md as a valid format, so I was wondering if org-mode was > sufficiently plain text to be added to the list of accepted