Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

27 lines (22 loc) · 1.41 KB
Raw

Contributing to PyVibe

Architecture

The generator directory contains the source assets. Everything else is generated from there.

---
title: Code Generation Flow
---
flowchart TD
    advanced(generator/includes/advanced.py.txt) --> generate.swift[[generator/generate.swift]]
    generate.swift --> spec(spec/spec.json)
    generate.swift --> init(src/__init__.py)
    spec --> generate.py[[generator/generate.py]]
    generate.py --> docs_html(docs/*.html)
    generate.py --> gallery_html(docs/gallery/*.html)
    gallery_html --> screenshot.py[[screenshot.py]]
    screenshot.py --> img(img/*.png)
Loading

Due to the architecture above, pull requests should be submitted only to files in the /generator subdirectory since everything else is generated from those files

Why Code Generation?

We want to minimize the need to have to search through documentation. Our goal is to be able to rely on autocomplete. To that end, we want to be able to attach .add_* methods to all appropriate components so that the list of available components in the current context is available. In order to minimize copy/paste, it's easiest to just generate the library code from a central definition.

Why Swift?

Very strongly typed languages with exhaustive enum checking makes code generation a lot more robust. Of the languages that would suit this criteria, Swift is probably the most readable for Python developers.