docs2data

Docs2Data

Решает проблему юзабилити для конфигурационных файлов.

• Машинно-читаемые конфиги — JSON, XML — совсем не для людей.
• YAML-конфиги
  • должны быть человекочитаемыми
  • но все равно слишком неудобны
    • особенно для представлений чего-то в табличном виде
• Markdown конфиги
  • используют Markdown-структурирование — секции, списки
  • человекочитаемы
  • легко превратить в документацию

Функции пакета

превращают их

• в вложенных питон-структуры
  • словари
  • списки
  • словари списков,
  • списки словарей и т.п.
  • представленные в виде
    ConfigNode
    объектов, которые ведут себя одновременно как словари и списки

Примеры

Примеры markdown-файлов

• и в какие структуры они превращаются
• можно посмотреть в папке ./tests/examples