namuan / code-video-generator

Generates code walkthrough videos using Manim

Code Video Generator is a library that uses the Manim animation engine to automatically generate code walkthrough videos. In fact, the source for the video above is at examples/intro.py.

Documentation

The documention is hosted at Read the Docs

Installation

Code Video Generator needs Manim and a few other dependencies. Please visit the documentation.

Usage

Here is an example video script that creates a video of itself:

from code_video import CodeScene


class MyScene(CodeScene):
    def construct(self):
        # This does the actual code display and animation
        self.animate_code_comments("simple.py")
    
        # Wait 5 seconds before finishing
        self.wait(5)

Save this code in a file called simple.py. Now open your terminal in the folder where you saved the file and execute

manim video.py -ql -p

You should see your video player pop up and play a simple walkthrough of video.py. You can find some more simple examples in the GitHub repository.

For more information on Manim, see their ReadTheDocs.

Contributing

If you'd like to contribute, feel free to fork or better yet, submit improvements as pull requests or report issues.

License

The software is licensed under the Apache Public License v2, with copyright by Sleuth Enterprises.