How to specify command defaults in config file

[Quaesius]

Hey, so this is maybe a dumb question, but I am a Manim and Python beginner and wondering how to edit the config for manim-slides and "enable" it globally, so I never have to worry about it again. For example, I think having everything in one file and independent of internet access is neat for converting to html, which is why it would be nice if I didn't have to type out

manim-slides SomeScene somescene.html --one-file --offline

every time. I do know that the relevant file is .manim-slides.toml, but I do not understand the syntax of the options in there and am pretty sure that this only applies locally?

In addition, is there a way to speficy where to put files resulting from convert, ideally in the config? E.g. always have the files appear in ./media/converted_slides, where . is the location of the slides-folder?

[jeertmans]

Hi @Quaesius, thanks for your questions!

First, the config file is not read globally, and it is currently only used to specify key bindings for the Qt player, here:

manim-slides/manim_slides/present/__init__.py

Lines 281 to 288 in c6ba210

	if config_path.exists():
	try:
	config = Config.from_file(config_path)
	except ValidationError as e:
	raise click.UsageError(str(e)) from None
	else:
	logger.debug("No configuration file found, using default configuration.")
	config = Config()

To do so, we would need to traverse the folders' tree at runtime (see what Flake8 does PyCQA/flake8#498 (comment)), and load possible config files found.

Second, we need to extend the current config to allow more things to be specified in it, like the default arguments passed to each command, but I am not sure how to do that elegantly.

Third, we should update the default values used by the command-line tool to match the default values from the config files instead.

In conclusion, I think everything is doable, but can take quite some time to implement, and it is not my priority now, but I'd gladly review any tentative PR!

Note

Converting to HTML should be:

manim-slides convert SomeScene somescene.html --one-file --offline

as you missed the convert command.

[Quaesius]

Ahh ok, thanks for the quick answer & correction ;) !

[jeertmans]

You're welcome! I have opened an issue for this, see #535