pidgy programming

pidgy treats code as literature and programming as a literacy. It is an interactive programming workflow in Markdown that allows narrative and code to develop together.

pidgy has literary and computational qualities that:

• Publish documentation and render PDFs using the ReadTheDocs service.

• Make it installable from pip and conda.

  pip install pidgy
  

• Formally test the literature and source code with Github Actions.

• Reusable on Binder.

• Import alternative source files into python like notebooks and markdown.

• The pidgy package and paper
  • The pidgy shell and kernel
  • Importing pidgy documents
  • The pidgy CLI

pidgy paper

• Introduction

pidgy specification

• The pidgy literate computing shell
  • pidgy specification
  • Initializing the pidgy shell
  • pidgy extension.

pidgy implementation

• Translating Markdown to Python
  • Block level lexical analysis.
  • Normalizing the tokens
  • Flattening the tokens to a [Python] string.
  • More pidgy langauge features
• Import Markdown files and notebooks
• Render and template output source
• Interactive formal testing
• pidgy metasyntax
  • Markdown is the primary language
  • Executing code.
  • Testing code
  • Weaving and templating code
    • Suppressing the weave output.
  • Emergent language features
  • Interactive Testing

pidgy applications

• pidgy kernel
  • pidgy kernel installation
• Export documents to other formats.
• Scripting with literate programs.
  • shebang statements in literate programs.
• Formally testing literate programs
• pidgy command line interface
• Discussion
  • Markdown for literate programming
  • Alternative source files

pidgy tests

• Test pidgy.tangle
• Test pidgy.runpidgy
• Test pidgy.magic
• Test 3rd party integrations.
• Create a simple fastapi application
• Tidy Data
• Figures

Source

• API Reference
  • pidgy
    • Subpackages
      • pidgy.pytest_config
    • Submodules
      • pidgy.__main__
      • pidgy.autocli
      • pidgy.base
      • pidgy.util

Indices and tables

• Index
• Module Index
• Search Page