bibliotekar.TrackingData

pydantic model bibliotekar.TrackingData

Tacking metadata for a notebook or script.

Show JSON schema

{
   "title": "TrackingData",
   "description": "Tacking metadata for a notebook or script.",
   "type": "object",
   "properties": {
      "version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Version"
      },
      "authors": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Author"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Authors"
      },
      "original_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Original Name"
      },
      "commit": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Commit"
      },
      "shelf_url": {
         "anyOf": [
            {
               "format": "uri",
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Shelf Url"
      },
      "hash": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hash"
      }
   },
   "$defs": {
      "Author": {
         "description": "Metadata about and author of some code.",
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "email": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Email"
            }
         },
         "title": "Author",
         "type": "object"
      }
   }
}

Fields:

• authors (list[bibliotekar.metadata.Author] | None)

• commit (str | None)

• hash (str | None)

• original_name (str | None)

• shelf_url (pydantic.networks.AnyUrl | None)

• version (bibliotekar.metadata.Version | bibliotekar.metadata.InvalidVersion | None)

field authors: list[Author] | None = None

field commit: str | None = None

field hash: str | None = None

field original_name: str | None = None

field shelf_url: AnyUrl | None = None

field version: Version | InvalidVersion | None = None

check_minimal()

Return type:

list[tuple[str, str]]