2.3.3.3. Paths

  • Relative Filepath[1]: path.yaml

  • Pre-configured: True

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

$schema: https://json-schema.org/draft/2020-12/schema
title: Paths
description: Paths to directories and files in the repository.
type: object
default: {}
additionalProperties: false
properties:
  dir:
    description: Paths to the main directories in the repository.
    type: object
    default: {}
    additionalProperties: false
    properties:
      source:
        description: Path to the source directory.
        type: string
        default: src
      tests:
        description: Path to the tests directory.
        type: string
        default: tests
      website:
        description: Path to the website directory.
        type: string
        default: docs/website
      local:
        description: Paths to the local directory and its subdirectories.
        type: object
        default: {}
        additionalProperties: false
        properties:
          root:
            description: Path to the local directory.
            type: string
            default: .local
          cache:
            description: Paths to the cache subdirectory of the local directory, and its subdirectories.
            type: object
            default: {}
            properties:
              root:
                description: Path to the root of the cache subdirectory, relative to the local directory.
                type: string
                default: cache
              repodynamics:
                description: Path to the RepoDynamics cache subdirectory, relative to the cache subdirectory.
                type: string
                default: repodynamics
              coverage:
                description: Path to the Coverage cache subdirectory, relative to the cache subdirectory.
                type: string
                default: coverage
              mypy:
                description: Path to the Mypy cache subdirectory, relative to the cache subdirectory.
                type: string
                default: mypy
              pylint:
                description: Path to the Pylint cache subdirectory, relative to the cache subdirectory.
                type: string
                default: pylint
              pytest:
                description: Path to the Pytest cache subdirectory, relative to the cache subdirectory.
                type: string
                default: pytest
              ruff:
                description: Path to the Ruff cache subdirectory, relative to the cache subdirectory.
                type: string
                default: ruff
            additionalProperties:
              description: >-
                Paths to other custom subdirectories of the cache subdirectory.
                These can be referenced in your custom configurations for other tools.
              type: string
            required: [ root, repodynamics, coverage, mypy, pylint, pytest, ruff ]
          report:
            description: Paths to the report subdirectory of the local directory, and its subdirectories.
            type: object
            default: {}
            properties:
              root:
                description: Path to the root of the report subdirectory, relative to the local directory.
                type: string
                default: report
              repodynamics:
                description: Path to the RepoDynamics reports subdirectory, relative to the report subdirectory.
                type: string
                default: repodynamics
              coverage:
                description: Path to the Coverage reports subdirectory, relative to the report subdirectory.
                type: string
                default: coverage
              mypy:
                description: Path to the Mypy reports subdirectory, relative to the report subdirectory.
                type: string
                default: mypy
              pylint:
                description: Path to the Pylint reports subdirectory, relative to the report subdirectory.
                type: string
                default: pylint
              pytest:
                description: Name of the pytest subdirectory under the report subdirectory.
                type: string
                default: pytest
              ruff:
                description: Path to the Pytest reports subdirectory, relative to the report subdirectory.
                type: string
                default: ruff
            additionalProperties:
              description: >-
                Paths to other custom subdirectories of the report subdirectory.
                These can be referenced in your custom configurations for other tools.
              type: string
            required: [ root, repodynamics, coverage, mypy, pylint, pytest, ruff ]
        required: [ root, cache, report ]
    required: [ source, local, tests, website ]
required: [ dir ]

dir:
  source: src
  tests: tests
  website: docs/website
  local:
    root: .local
    cache:
      root: cache
      repodynamics: repodynamics
      coverage: coverage
      mypy: mypy
      pylint: pylint
      pytest: pytest
      ruff: ruff
    report:
      root: report
      repodynamics: repodynamics
      coverage: coverage
      mypy: mypy
      pylint: pylint
      pytest: pytest
      ruff: ruff

# Paths to the main directories in the repository:
dir:

  # Path to the source directory:
  source: src

  # Path to the tests directory:
  tests: tests

  # Path to the website directory:
  website: docs/website

  # Paths to the local directory and its subdirectories:
  local:

    # Path to the local directory:
    root: .local

    # Paths to the cache subdirectory of the local directory,
    # and its subdirectories:
    cache:

      # Name of the cache subdirectory under the local directory:
      root: cache

      # Name of subdirectories under the cache subdirectory;
      # the following key:value pairs are set by default:
      repodynamics: repodynamics
      coverage: coverage
      mypy: mypy
      pylint: pylint
      pytest: pytest
      ruff: ruff
      # You can add other key:value pairs here for other tools that you use.

    # Paths to the report subdirectory of the local directory,
    # and its subdirectories:
    report:

      # Name of the report subdirectory under the local directory:
      root: report

      # Name of subdirectories under the report subdirectory;
      # the following key:value pairs are set by default:
      repodynamics: repodynamics
      coverage: coverage
      mypy: mypy
      pylint: pylint
      pytest: pytest
      ruff: ruff
      # You can add other key:value pairs here for other tools that you use.

The path.yaml configuration file allows you to customize the paths to various directories and files that PyPackIT manages and works with in your repository.

Directories

Declarations for paths to your repository’s main directories.