Core API¶
Boussole is mainly a commandeline tool but it relies on a core API that may be used to implement another frontend.
This part of Boussole should not concern end users because they don’t directly exploit it, it documents some behaviors but they should be better documented from Tutorial.
The core API should be 100% covered for documentation and unittests.
Modules¶
- Exceptions
BoussoleBaseException
InvalidImportRule
FinderException
UnresolvablePath
UnclearResolution
CircularImport
SettingsDiscoveryError
SettingsBackendError
SettingsInvalidError
- Parser
ScssImportsParser
SassImportsParser
- Resolver
ImportPathsResolver
- Inspector
ScssInspector
- Finder
paths_by_depth()
ScssFinder
- Logging
init_logger()
- Project configuration
- Settings model
Settings
- Settings backend post processing
SettingsPostProcessor
- Base settings backend
SettingsBackendBase
SettingsBackendBase._default_filename
SettingsBackendBase._kind_name
SettingsBackendBase._file_extension
SettingsBackendBase.parse_filepath()
SettingsBackendBase.check_filepath()
SettingsBackendBase.open()
SettingsBackendBase.parse()
SettingsBackendBase.dump()
SettingsBackendBase.clean()
SettingsBackendBase.load()
- JSON settings backend
SettingsBackendJson
- YAML settings backend
SettingsBackendYaml
- Backend discover
Discover
- Sass compile helper
SassCompileHelper
- Source watcher
SassLibraryEventHandler
SassLibraryEventHandler.settings
SassLibraryEventHandler.logger
SassLibraryEventHandler.inspector
SassLibraryEventHandler.finder
SassLibraryEventHandler.compiler
SassLibraryEventHandler.compilable_files
SassLibraryEventHandler.source_files
SassLibraryEventHandler._event_error
SassLibraryEventHandler.is_valid_event()
SassLibraryEventHandler.index()
SassLibraryEventHandler.compile_source()
SassLibraryEventHandler.compile_dependencies()
SassLibraryEventHandler.on_any_event()
SassLibraryEventHandler.on_moved()
SassLibraryEventHandler.on_created()
SassLibraryEventHandler.on_modified()
SassLibraryEventHandler.on_deleted()
SassProjectEventHandler
WatchdogLibraryEventHandler
WatchdogProjectEventHandler
- Project management
ProjectBase
ProjectStarter