Configuration

For now, see bamboost._config for available options (consult the attributes of the options and index classes).

Some level of configuration is available. This includes:

Search paths for collections
Dir names to exclude when searching for collections (e.g. “.git”)
Default sorting parameter or metadata key
…more

There is a global config file that is always considered

~/.config/bamboost/config.toml

[options]
...

[index]
...

In addition, project specific configuration is supported too. You can either do this in the pyproject.toml file, or create a bamboost.toml file at the root of your project (where either pyproject.toml is, or a .git directory).

pyproject.toml

# other content

[tool.bamboost.options]
...

[tool.bamboost.index]
...

bamboost.toml

# other content

[options]
...

[index]
...