betty.project package

Subpackages

• betty.project.extension package
  • Submodules
    • betty.project.extension.requirement module
      • Dependencies
        • Dependencies.__init__()
        • Dependencies.summary()
      • Dependents
        • Dependents.__init__()
        • Dependents.is_met()
        • Dependents.summary()
  • Module contents
    • ConfigurableExtension
      • ConfigurableExtension.__init__()
      • ConfigurableExtension.default_configuration()
    • CyclicDependencyError
      • CyclicDependencyError.__init__()
    • EXTENSION_REPOSITORY
    • Extension
      • Extension.__init__()
      • Extension.assets_directory_path()
      • Extension.comes_after()
      • Extension.comes_before()
      • Extension.depends_on()
      • Extension.disable_requirement()
      • Extension.enable_requirement()
      • Extension.new_for_project()
      • Extension.project
      • Extension.register_event_handlers()
    • ExtensionError
    • Theme
    • build_extension_type_graph()

Submodules

• betty.project.config module
  • DEFAULT_LIFETIME_THRESHOLD
  • EntityReference
    • EntityReference.__init__()
    • EntityReference.dump()
    • EntityReference.entity_id
    • EntityReference.entity_type
    • EntityReference.entity_type_is_constrained
    • EntityReference.load()
    • EntityReference.update()
  • EntityReferenceSequence
    • EntityReferenceSequence.__init__()
    • EntityReferenceSequence.load_item()
  • EntityTypeConfiguration
    • EntityTypeConfiguration.__init__()
    • EntityTypeConfiguration.dump()
    • EntityTypeConfiguration.entity_type
    • EntityTypeConfiguration.generate_html_list
    • EntityTypeConfiguration.load()
    • EntityTypeConfiguration.update()
  • EntityTypeConfigurationMapping
    • EntityTypeConfigurationMapping.load_item()
  • EventTypeConfigurationMapping
  • ExtensionConfiguration
    • ExtensionConfiguration.__init__()
    • ExtensionConfiguration.dump()
    • ExtensionConfiguration.enabled
    • ExtensionConfiguration.extension_configuration
    • ExtensionConfiguration.extension_type
    • ExtensionConfiguration.load()
    • ExtensionConfiguration.update()
  • ExtensionConfigurationMapping
    • ExtensionConfigurationMapping.__init__()
    • ExtensionConfigurationMapping.enable()
    • ExtensionConfigurationMapping.load_item()
  • LocaleConfiguration
    • LocaleConfiguration.__init__()
    • LocaleConfiguration.alias
    • LocaleConfiguration.dump()
    • LocaleConfiguration.load()
    • LocaleConfiguration.locale
    • LocaleConfiguration.update()
  • LocaleConfigurationMapping
    • LocaleConfigurationMapping.__init__()
    • LocaleConfigurationMapping.default
    • LocaleConfigurationMapping.load_item()
    • LocaleConfigurationMapping.multilingual
    • LocaleConfigurationMapping.replace()
    • LocaleConfigurationMapping.update()
  • ProjectConfiguration
    • ProjectConfiguration.__init__()
    • ProjectConfiguration.assets_directory_path
    • ProjectConfiguration.author
    • ProjectConfiguration.base_url
    • ProjectConfiguration.clean_urls
    • ProjectConfiguration.configuration_file_path
    • ProjectConfiguration.debug
    • ProjectConfiguration.dump()
    • ProjectConfiguration.entity_types
    • ProjectConfiguration.event_types
    • ProjectConfiguration.extensions
    • ProjectConfiguration.lifetime_threshold
    • ProjectConfiguration.load()
    • ProjectConfiguration.locales
    • ProjectConfiguration.localize_www_directory_path()
    • ProjectConfiguration.logo
    • ProjectConfiguration.name
    • ProjectConfiguration.output_directory_path
    • ProjectConfiguration.project_directory_path
    • ProjectConfiguration.root_path
    • ProjectConfiguration.title
    • ProjectConfiguration.update()
    • ProjectConfiguration.url
    • ProjectConfiguration.www_directory_path
• betty.project.factory module
  • ProjectDependentFactory
    • ProjectDependentFactory.new_for_project()

Module contents

Provide the project API.

Projects are how people use Betty. A project is a workspace, starting out with the user’s configuration, and combining it with the resulting ancestry, allowing the user to perform tasks, such as generating a site from the entire project.

final class betty.project.Project

Bases: Configurable[ProjectConfiguration], DependentFactory[Any], CoreComponent

Define a Betty project.

A project combines project configuration and the resulting ancestry.

__init__(app: App, configuration: ProjectConfiguration, *, ancestry: Ancestry | None = None)

property ancestry: Ancestry

The project’s ancestry.

property app: App

The application this project is run within.

property assets: AssetRepository

The assets file system.

async bootstrap() → None

Bootstrap the component.

property event_dispatcher: EventDispatcher

The event dispatcher.

property event_types: PluginRepository[EventType]

The event types available to this project.

property extensions: ProjectExtensions

The enabled extensions.

property jinja2_environment: Environment

The Jinja2 environment.

property localizers: LocalizerRepository

The available localizers.

property logo: Path

The path to the logo file.

property name: str

The project name.

If no project name was configured, this defaults to the hash of the configuration file path.

async new(cls: type[Any]) → Any

Create a new instance.

Raises:

FactoryError – raised when the class could not be instantiated.

classmethod new_temporary(app: App, *, ancestry: Ancestry | None = None) → AsyncIterator[Self]

Creat a new, temporary, isolated project.

The project will not leave any traces on the system, except when it uses global Betty functionality such as caches.

property renderer: Renderer

The (file) content renderer.

property static_url_generator: StaticUrlGenerator

The static URL generator.

property url_generator: LocalizedUrlGenerator

The (localized) URL generator.

class betty.project.ProjectContext

Bases: Context

A job context for a project.

__init__(project: Project)

property project: Project

The Betty project this job context is run within.

class betty.project.ProjectEvent

Bases: Event

An event that is dispatched within the context of a betty.project.Project.

__init__(job_context: ProjectContext)

property job_context: ProjectContext

The site generation job context.

property project: Project

The betty.project.Project this event is dispatched within.

final class betty.project.ProjectExtensions

Bases: object

Manage the extensions running within the betty.project.Project.

This is internal. It MAY be used anywhere in Betty’s source code, but MUST NOT be used by third-party code.

__init__(project_extensions: Sequence[Sequence[Extension]])

flatten() → Iterator[Extension]

Get a sequence of topologically sorted extensions.

final class betty.project.ProjectSchema

Bases: Schema

A JSON Schema for a project.

classmethod def_url(project: Project, def_name: str) → str

Get the URL to a project’s JSON Schema definition.

async classmethod new(project: Project) → Self

Create a new schema for the given project.

classmethod url(project: Project) → str

Get the URL to a project’s JSON Schema.

classmethod www_path(project: Project) → Path

Get the path to the schema file in a site’s public WWW directory.