Nerodia Reference Manual

 Nerodia Reference Manual🔗

Mac Malone

Nerodia is a library for Lean/Python FFI inspired by PyO3. It utilizes Lake, Lean's build system, to provide seamless integration. The name of the library comes from the genus Nerodia, a type of water snake. That is, a snake you would find in a lake.

Nerodia logo

This manual provides tutorials to help new users get started, a general outline of Nerodia's structure, and a reference of the Python API it exposes.

Important: Nerodia (and this reference manual) is still a work-in-progress and currently has a very limited API. It is released to the public primarily as a proof-of-concept and to obtain feedback on its design and build process.

Contents

  1. 1. Requirements
  2. 2. API Stability
  3. 3. Changelog
  4. 4. Tutorials
  5. 5. Annotations
  6. 6. Type Conversions
  7. 7. Python Typing
  8. 8. Python Types
  9. 9. Monads