Welcome to porchlight’s documentation!

porchlight is an open-source function management package designed for coupling Python functions and managing shared data.

Contents:

• About porchlight
  • Background
  • Example use cases
  • FAQ
• Quickstart
  • Requirements
  • Installation
  • Type annotations and porchlight
  • Creating a Neighborhood object
  • Param objects
  • Door objects
  • Closing Nuances
• neighborhood module
  • Neighborhood
  • NeighborhoodError
• door module
  • BaseDoor
  • Door
  • DoorError
  • DoorWarning
  • DynamicDoor
• param module
  • Empty
  • Param
  • ParameterError
• utils module
  • Inspection utilities
  • Typing utilities

Indices and tables

• Index

• Module Index

• Search Page

Note

This project is under active development. Please report any bugs you encounter to https://github.com/teald/porchlight/issues!