API Reference

Knackpy API Reference #

To understand knackpy’s design, it’s helpful to think of it in terms of two entry points:

  • Api: Contains core functions for over-the-wire interactions with the Knack API, as well as helpers for pagination and re-trying on request failures.
  • App: The highest-level container for getting and interacting with Knack records.

The other the knackpy classes act as a hierarchy that are constructed through a chain of side-effects originating from App objects.

  • Record: A dict-like container for Field objects which supplies helpers for accesing and formatting fields.
  • Field: A container for a single Knack key/value, with helpers for formatting.
  • FieldDef: Stores field metadata (type, formatting method, parent objects/views)

menu: main title: API Reference #