Skip to main content

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 MyPresentation and manim-slides MyPresentation commands
  • 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

manim_presentations-0.1.8.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

manim_presentations-0.1.8-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file manim_presentations-0.1.8.tar.gz.

File metadata

  • Download URL: manim_presentations-0.1.8.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for manim_presentations-0.1.8.tar.gz
Algorithm Hash digest
SHA256 18b90d47533c3799ad332412a2963aee0a0137553c34d63cbf26bcada4236265
MD5 4ab0ff0a4b3db93f0ad30ba252448c2c
BLAKE2b-256 adef0fb05615017c2b2feb9b239f7388e127ef5426a7cbf8a9bbf48a69ac514c

See more details on using hashes here.

File details

Details for the file manim_presentations-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for manim_presentations-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7536156625a79588594df5ec9661334549a381efc6885f9422350d50646a96bd
MD5 8ef8a3154602351e528cd5d3bc3abd22
BLAKE2b-256 c11a49234e4ede7e4ade7b6a96d2629bbb5d97eb09df00282bed479c67175bb6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page