daneah / pep-connections Goto Github PK

Connecting each PEP to its author(s) and BDFL delegate can help understand who has been responsible for many PEPs and specific PEP topics/areas.

Outcome

• Each person who is either an author or a BDFL delegate has their own file containing their name as a level one heading
• Each output PEP file has a section with a list of the authors and BDFL delegate, where each mentioned person is linked to the respective person file

Right now, name parsing assumes commas as strictly a name delimiter. However, there is at least one case where a , Jr. throws this off, resulting in a note for just Jr. on its own.

Some PEPs are meant to propose standards, but others are simply informational. Tagging each PEP in the output with its type will help differentiate them.

Outcome

• Each output PEP has one type--<type-of-pep> tag indicating the PEP's type

Each output file currently has just the tags, title, and connection to other mentioned PEPs. This is easy enough to do, but doesn't let people understand what each PEP is in context as they browse it in Obsidian.

Outcome

• Each PEP has the full PEP body in the output Markdown, transformed appropriately as noted below.

Notes

The reStructuredText can't just be shoved into the Markdown file, because the syntax will conflict. Some things should probably be transformed as well because they don't have an easy parallel. An example is the :pep: reference syntax—that could be converted to links (and possibly remove some of the need for the current Mentions section in the process)

Some of the metadata in the front matter might be able to be kept. Obsidian supports front matter in Markdown and treats it separately and specially from the document. Some is redundant with existing tags.

reStructuredText is a formal grammar and it would be nice to use that rather than parsing files as plain text. This might improve the capabilities for #3 and would probably simplify and make more extensible the metadata field parsing.

Outcome

• connect.py code uses a package for parsing reStructuredText and generates output from the structured parsed data

Find a way to clean the resulting Markdown after conversion from reStructuredText, because it can result in things that look like note references that actually aren't.