A library for creating and managing slide decks
Project description
Fastdeck
Fastdeck is a Python library for creating and managing slide decks.
Fastdeck Python library is maintained to support the app ⚡️Fastdeck AI.
Create and share minimal slides in seconds, on the go.
Installation
You can install FastDeck using pip:
pip install fastdeck
Usage
Here's a basic overview of how to use FastDeck:
- Import the necessary classes:
from fastdeck import Presentation, Slide, Content
- Create a presentation:
presentation = Presentation()
- Create slides and add content:
slide = Slide()
content = Content()
content.add_heading("Welcome to FastDeck")
content.add_text("This is a simple demonstration of FastDeck capabilities.")
slide.add_content([content.render()])
- Add the slide to the presentation:
presentation.add_slide(slide)
- Generate and save the HTML:
presentation.save_html("my_presentation.html")
Example
Here's a more comprehensive example that demonstrates various features of FastDeck:
from fastdeck import Presentation, Slide, Content
import plotly.express as px
# Create a new presentation
presentation = Presentation()
# Create the title slide
title_slide = Slide(center=True)
title_content = Content()
title_content.add_heading("FastDeck Demo", tag="h1")
title_content.add_text("A powerful library for creating slide decks")
title_slide.add_content([title_content.render()])
presentation.add_slide(title_slide)
title_slide.save_slide_html('title_slide.html') # Save individual slide
# Create a content slide
content_slide = Slide()
content = Content()
content.add_heading("Features of FastDeck")
content.add_list([
"Easy to use Python API",
"Support for various content types",
"Customizable styles",
"Export to HTML"
])
content_slide.add_content([content.render()])
presentation.add_slide(content_slide)
content_slide.save_slide_html('content_slide.html') # Save individual slide
# Create a slide with a Plotly graph
plotly_slide = Slide()
plotly_content = Content()
plotly_content.add_heading("Plotly Graph")
df = px.data.iris()
fig = px.scatter(df, x='sepal_width', y='sepal_length', color='species', size='petal_length', hover_data=['petal_width'])
fig.update_layout(autosize=True)
json_fig = fig.to_json()
plotly_slide.add_content([json_fig], columns=[12], styles=[{'class': 'stretch'}])
presentation.add_slide(plotly_slide)
plotly_slide.save_slide_html('plotly_slide.html') # Save individual slide
# Save the entire presentation
presentation.save_html("fastdeck_demo.html")
This example creates a presentation with three slides:
- A title slide
- A content slide with a list of features
- A slide with a Plotly graph
After running this script, you'll have an HTML file named fastdeck_demo.html
that you can open in a web browser to view your presentation.
Documentation
For more detailed information about FastDeck's classes and methods, please refer to the documentation.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Acknowledgements
- Reveal.js
- This python package is inspired by the respysive-slide wrapper.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.