Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.51 KB

README.rst

File metadata and controls

56 lines (37 loc) · 1.51 KB
Raw

PyReveal Library

PyReveal is a Python library that allows users to generate Reveal.js presentations programmatically. With PyReveal, you can easily create slides, set themes, transitions, and even add custom backgrounds like images or videos.

Features

  • Create Reveal.js presentations using Python.
  • Support for slide themes and transitions.
  • Error handling and validation for slide content.
  • Export presentations to HTML.
  • Support for slide backgrounds, including images, videos, and colors.
  • Parallax background support.

Installation

pip install pyreveal

Usage

from pyreveal import PyReveal, ImageBackground

presentation = PyReveal(title="My Presentation", theme="white", transition="slide")
presentation.add_slide("Welcome to PyReveal!")
bg_image = ImageBackground(image_url="path/to/image.jpg")
presentation.add_slide("This slide has a background image!", background=bg_image)
presentation.save_to_file("my_presentation.html")

For more advanced usage and features, please refer to the documentation.

Contribute

Support

If you are having issues, please let us know. You can report issues on the issue tracker mentioned above.

License

The project is licensed under the MIT license. See the LICENSE file for more details.