Metadata

pydantic model safir.metadata.Metadata

Metadata about a package.

Parameters:

data (Any)

Show JSON schema

{
   "title": "Metadata",
   "description": "Metadata about a package.",
   "type": "object",
   "properties": {
      "name": {
         "examples": [
            "myapp"
         ],
         "title": "Application name",
         "type": "string"
      },
      "version": {
         "examples": [
            "1.0.0"
         ],
         "title": "Version",
         "type": "string"
      },
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            "Some package description"
         ],
         "title": "Description"
      },
      "repository_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            "https://example.com/"
         ],
         "title": "Repository URL"
      },
      "documentation_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "examples": [
            "https://example.com/"
         ],
         "title": "Documentation URL"
      }
   },
   "required": [
      "name",
      "version"
   ]
}

Fields:

• description (str | None)

• documentation_url (str | None)

• name (str)

• repository_url (str | None)

• version (str)

field description: str | None = None

field documentation_url: str | None = None

field name: str [Required]

field repository_url: str | None = None

field version: str [Required]