pypreset

User Guide

  • Quickstart
    • Installation
    • Creating Your First Project
    • Using Presets
    • Customizing Projects
    • Augmenting Existing Projects
    • Verifying Workflows
    • User Configuration
    • Version Management
    • PyPI Metadata
  • Presets
    • Built-in Presets
    • Preset YAML Schema
    • Inheritance
      • Placeholders
    • Custom Presets
  • Templates
    • Available Templates
    • Template Context
    • Package Manager Selection
    • README Template
    • Writing Custom Templates
  • MCP Server
    • Installation
    • Client Configuration
    • Available Tools
      • Tool Parameters
    • Available Resources
    • Guided Prompts
    • Architecture

Developer Guide

  • Architecture
    • Overview
    • Create Command Flow
    • Augment Command Flow
    • Workflow Verification Flow
    • Configuration Priority
    • Key Modules
    • Preset System
    • Template System
    • Package Manager Abstraction
  • API Reference
    • Models
      • LayoutStyle
      • TypingLevel
      • TestingFramework
      • FormattingTool
      • TypeChecker
      • CreationPackageManager
      • ContainerRuntime
      • CoverageTool
      • DocumentationTool
      • FileTemplate
      • DirectoryStructure
      • DependencyGroup
      • Dependencies
      • CoverageConfig
      • TestingConfig
      • FormattingConfig
      • DependabotConfig
      • DockerConfig
      • DocumentationConfig
      • ToxConfig
      • Metadata
      • EntryPoint
      • PartialMetadata
      • PartialDirectoryStructure
      • PartialDependencies
      • PartialCoverageConfig
      • PartialTestingConfig
      • PartialFormattingConfig
      • PartialDependabotConfig
      • PartialDockerConfig
      • PartialDocumentationConfig
      • PartialToxConfig
      • ProjectConfig
      • PresetConfig
      • OverrideOptions
    • Preset Loader
      • get_builtin_presets_dir()
      • get_user_presets_dir()
      • load_yaml_file()
      • deep_merge()
      • find_preset_file()
      • list_available_presets()
      • load_preset()
      • resolve_preset_chain()
      • apply_overrides()
      • build_project_config()
    • Generator
      • ProjectGenerator
      • generate_project()
    • Augment Generator
      • AugmentComponent
      • GeneratedFile
      • AugmentResult
      • get_augment_templates_dir()
      • create_augment_jinja_env()
      • get_augment_context()
      • ComponentGenerator
      • TestWorkflowGenerator
      • LintWorkflowGenerator
      • DependabotGenerator
      • TestsDirectoryGenerator
      • GitignoreGenerator
      • PypiPublishWorkflowGenerator
      • DockerfileGenerator
      • DevcontainerGenerator
      • CodecovGenerator
      • DocumentationGenerator
      • ToxGenerator
      • PyenvGenerator
      • VersionSyncGuardGenerator
      • ReadmeGenerator
      • AugmentOrchestrator
      • augment_project()
    • Docker Utilities
      • resolve_docker_base_image()
    • Template Engine
      • get_templates_dir()
      • create_jinja_environment()
      • get_template_context()
      • render_template()
      • render_content()
      • render_path()
    • Validator
      • ValidationResult
      • ProjectValidator
      • validate_project()
      • validate_with_poetry()
    • Project Analyzer
      • PackageManager
      • DetectedLinter
      • DetectedTestFramework
      • DetectedTypeChecker
      • AnalysisConfidence
      • DetectedValue
      • MissingField
      • ProjectAnalysis
      • ProjectAnalyzer
      • analyze_project()
    • User Config
      • get_config_path()
      • load_user_config()
      • apply_user_defaults()
      • save_user_config()
      • get_default_config_template()
    • Metadata Utilities
      • read_pyproject_metadata()
      • set_pyproject_metadata()
      • check_publish_readiness()
      • generate_default_urls()
    • Act Runner
      • ActError
      • ActCheckResult
      • ActRunResult
      • ActInstallResult
      • WorkflowVerifyResult
      • check_act()
      • get_install_suggestion()
      • install_act()
      • run_act()
      • verify_workflow()
    • Versioning
      • VersioningError
      • CommandFailure
      • CommandRunner
      • SubprocessRunner
      • sync_server_file()
      • VersioningAssistant
    • MCP Server
      • create_server()
      • main()
      • Tools
      • Resources
      • Prompts
pypreset
  • Search

© Copyright 2026, pypreset contributors.

Built with Sphinx using a theme provided by Read the Docs.