A Python framework for creating composable manim-slides presentations.
Project description
ManimPresentations
This is a minimal and quick-and-dirty package to make ManimSlides more modular and reduce the time required to create presentations. It unifies the way presentations are created and displayed. It allows composition of chapters as list of slides and of presentations as list of chapters. That way, your slides and chapters can be reused in different presentations. Furthermore, it allows to render individual slides and chapters, so you don't have to render the whole presentation every time you want to see a change.
Main objectives:
- have a clear hierarchy: presentation -> chapters -> slides
- have shared elements between slides (slide number, presentation title, author, year, event, current chapter, etc.)
- being able to compose Presentations using various chapters and slides
- being able to render and launch the whole presentation with the usual
manim-slides render example.py MyPresentationandmanim-slides MyPresentationcommands - provide an elegant layout for presentations
State of the project:
This is a personal project that I started to make my life easier when creating presentations with Manim. It may be useful to others, but do not consider it a complete, elegant or polished solution. It probably lacks a lot of useful features to make it a general tool, but it's not my intention to make it so :)
If you have suggestions, ideas or feedback, feel free to open a discussion though!
Installation:
You can install this package using pip:
pip install manim-presentations
To install locally, you can clone the repository and run:
pip install -e .
Components:
ModularSlide
A ModularSlide is a single slide in a presentation. It extends the manim_slides.Slide class, so it's a Manim Scene.
The magic is in the ctx context argument that is passed to the __init__ method. By default this context is None,
in which case the slide behaves like a normal Manim Scene/Slide, allowing you to use it as a standalone scene. But this
context can also be an instance of manim_presentations.Presentation or manim_presentations.Chapter, which allows
rendering the slide within the presentation or chapter.
A ModularSlide also contains an inner_canvas attribute, which is a manim.Group intended to contain the graphical
elements of the slide. The default tear_down method clears this inner canvas, but can be overridden by your custom
slide class. This allows you to create slides that reuse the canvas from a previous slide, although this requires
knowing how the previous slide organised its canvas in the first place.
Chapter
A chapter is a portion of a presentation that can be composed of multiple ModularSlides. By default, its construct
method iterates over the slides and renders them one by one.
It also receives a ctx context argument, which can be an instance of manim_presentations.Presentation but is None
by default. This allows to render a chapter as a standalone scene, or as part of a presentation.
Presentation
A presentation is the actual, complete presentation that you want to create. It receives chapters as a list of Chapter
instances and renders them in the order they are provided.
It has properties like the title, presenting author, other authors, year, event it is made for, and a list of chapters.
It implements various methods for:
- introduction and conclusion slides
- building, showing, hiding and updating various layout elements like slide number, chapter progression or sub-text.
- ...
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file manim_presentations-0.1.71.tar.gz.
File metadata
- Download URL: manim_presentations-0.1.71.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
208bd5d65e737c899fd1429b76dc8a078b00c53a0b63035f4808ecbc43db7381
|
|
| MD5 |
3e45f28ca04eea3af08e39b49dc0750d
|
|
| BLAKE2b-256 |
076287b661a1c66843a140d1e1a0e24805391012c5ed892b8e59ff17e5c80754
|
File details
Details for the file manim_presentations-0.1.71-py3-none-any.whl.
File metadata
- Download URL: manim_presentations-0.1.71-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b33db922788cae5deddb101c04c99fa70da76a75c2a3f5848c0124c46fee506
|
|
| MD5 |
d27d6135668632db0910e4838701e654
|
|
| BLAKE2b-256 |
5773b3f3fd7753abd62f059de70335a421de294d80dee91714252beac8c18fe9
|