Architecture

The following pages contain information how Foundry DevTools is structured, and how one could extend it.

• API client implementation
  • The api_name attribute
  • The api_request method
  • Naming conventions
    • Classes
    • Methods
      • Direct API calls
      • Higher level methods
  • API typing
  • Example
    • Errors
      • UserNotFound
      • UserAlreadyExists
      • InsufficientPermissions
    • API Methods
      • Get User Info
      • Change User Info
      • List users
      • Create User
• Foundry DevTools Exceptions
  • Foundry API Errors
    • Error mapping
    • Raise Foundry API Errors
    • ErrorHandlingConfig
      • get_exception method
      • get_exception_class method
      • Get parameters
    • Implement a custom exception
• Extending Foundry DevTools
  • Adding Token Providers
    • Without entry points
  • Adding API clients
    • Without entry points
• FoundryContext
  • Client
    • auth handler
• Token provider implementation
  • requests auth handler
  • Cached token provider
  • More configuration details
• Transforms implementation
  • How the transforms library that exists on Foundry is stubbed in Foundry DevTools

Known limitations (Contributions Welcome 🤗)

• CSV format settings are not taken over from the Foundry Schema. Advised to use datasets in parquet format.

• transforms Output not written back to foundry

• @incremental not implemented

• @configure not implemented