Orgmode support

[davidam]

Hello,

It would be nice add orgmode support. You can find orgmode parsers in https://orgmode.org/worg/org-tools/index.html

Thanks.

[miketheman]

Hello! Circling back to this, and I was curious about the expected workflow here.
Is it common for Org mode users to write README-style files for projects and leave them in Org mode, or would it make more sense to export the Org mode document into the desired format, like RST? https://github.com/msnoigrs/ox-rst

[davidam]

Orgmode did start to write TODO.org files, but it was evolving to many things, people write wikis, blogs or static web sites, articles, manual or papers with orgmode. They write README files, too. I have been being user of orgmode and I find easy remember the orgmode sintaxis and would be nice can write the README files in orgmode.

[createyourpersonalaccount]

What help is needed for this in particular? I can do this.

@miketheman Org is used in the Emacs editor to do all things office-related and note-taking related. It is trivial to support a subset of Org for the purpose of rendering README.org, that's what GitHub and GitLab do.

[novoid]

I've summarized how Github and Gitlab are supporting the syntax of Org-mode on pypi/warehouse#18657 (it's a Ruby library).

Please not that Orgdown, the syntax of Emacs Org-mode has good support outside of the GNU Emacs platform. So it's not just an Emacs-topic if somebody got the impression.

It's also a very good choice to use instead of Markdown to avoid the flavor hell of MD which introduces all sorts of issues when you're working with text syntax files.

[nbehrnd]

How does pypi gets hold on the README within a wheel to become the landing page on either (test.)pypi.org? Conceptually, I think one workflow could consist of

• check for a pyproject.toml file
• check this one for the line readme = ... to determine the location of the file eventually of interest
• by either file extension .rst, or .md set a converter to translate this into .html

Does PyPI uses pandoc, or would be using pandoc as a GitHub/GitLab action/docker image be an option for you to convert either the .org directly, or by a gfm Markdown as an intermediate, into the .html? See the pandoc's documentation and example action, as well as the pandoc marketplace entry. Perhaps in 2019 when @davidam initiated this thread, the infrastructure was not yet this available yet.

[createyourpersonalaccount]

@nbehrnd The code that deals with READMEs is here warehouse/utils/readme.py. See also file_upload().