2.3.3. Options

This section contains a full reference and detailed explanation of all available options in your repository’s control center. These are divided into two categories: non-extendable and extendable options. Non-extendable options are those that are required by PyPackIT during the processing of your control center, and thus cannot be extended from other repositories. These are all stored in YAML files at the root of your repository’s control center directory. Extendable options, on the other hand, are those that can be freely extended from other repositories, and are organized into subdirectories within your repository’s control center.

Non-Extendable Options

Extensions

Extension definitions for your control center’s contents.

Base Config

Base configurations for the control center itself.

Paths

Path definitions for your repository’s main directories.

Extendable Options

Project

Core information about your project, including name and various descriptions, license and copytight information, credits and funding options, etc.

Development

Configurations and metadata for your software development process, GitHub/Git repository, CI/CD/CT workflows, and most of PyPackIT-specific options and settings.

Package

Configurations and metadata specific to your Python package and its test suite, including build settings, PEP 621 metadata, dependencies, entry points, etc.

User Interfaces

Configurations, metadata, and media files for your project’s user interfaces, including documentation website, README files, health files, themes and branding, etc.

Custom

User-defined custom variables that can be used throughout your repository’s control center and documentation website.