2.3.3.6.7. Metadata¶

Info

Relative Filepath^[1]: package_python/metadata.yaml
Pre-configured: True

[1]: Filepath is relative to the root of the control center directory.

Schema

$schema: https://json-schema.org/draft/2020-12/schema
title: meta_package_metadata
description: Package metadata
type: object
default: { }
additionalProperties: false
properties:
  manifest:
    description: MANIFEST.in configuration
    type: array
    default:
      - graft ${{ path.dir.source }}/${{ package.import_name }}
      - include CODE_OF_CONDUCT.md
      - global-exclude *.py[cod] __pycache__ *.so
    uniqueItems: true
    items:
      type: string

  typed:
    description: Whether the package is typed
    type: boolean
    default: true

  trove_classifiers:
    description: Trove classifiers for the project
    type: array
    default: []
    uniqueItems: true
    items:
      type: string
      pattern: '^[\w\s\-]+( :: [\w\s\-]+)+$'

  urls:
    description: URLs for the project
    type: object
    default:
      Homepage: ${{ url.website.base }}
      Download: ${{ url.github.releases.home }}
      News: ${{ url.website.news }}
      Documentation: ${{ url.website.base }}
      Issue-Tracker: ${{ url.github.issues.home }}
      Sponsor: ${{ url.website.sponsor }}
      Source: ${{ url.github.home }}
    additionalProperties:
      type: string

Default

manifest:
- graft ${{ path.dir.source }}/${{ package.import_name }}
- include CODE_OF_CONDUCT.md
- global-exclude *.py[cod] __pycache__ *.so
typed: true
trove_classifiers: []
urls:
  Homepage: ${{ url.website.base }}
  Download: ${{ url.github.releases.home }}
  News: ${{ url.website.news }}
  Documentation: ${{ url.website.base }}
  Issue-Tracker: ${{ url.github.issues.home }}
  Sponsor: ${{ url.website.sponsor }}
  Source: ${{ url.github.home }}

Example

Note

The package name is derived from the name of the project, via normalization[1]: The project name is lowercased, with all runs of spaces, periods, underscores and hyphens replaced with a single hyphen.