Skip to content

README.md

Latest commit

 

History

History
90 lines (61 loc) · 2.22 KB

README.md

File metadata and controls

90 lines (61 loc) · 2.22 KB
Raw

presentation-creator

Easily create a PowerPoint without putting in the work.

Table of Contents

  1. Introduction
  2. Installation
  3. Configuration
  4. Usage
  5. Example
  6. Contributing
  7. License

Introduction

Welcome to my presentation creator. I created that as I got sick of writing bullet points and adding them to my PowerPoint presentations.

Installation

To use the creator you must clone this repo and install the requirements.

# Example installation instructions
git clone https://github.com/Niklas-dev/presentation-creator.git

# Create a python venv
python -m venv venv

# Install dependencies
pip install -r requirements.txt

Configuration

Before you can run the project you must get get a OpenAI API key, which is free (limited usage). Add the API Key to the env as described below. You must also create an output foler in the root dir, after execution your pptx file and script will be in there.

# Create a .env file
touch .env
# Add configuration variables
OPENAI_API_KEY=sk-this-is-a-cool-fake-api-key

Usage

After installing the dependencies you can run the main script with the additional params. All params must be defined. Enter your topic(--topic), you desired sub topics (--subtopics_amount) and the length of the presentation (--length_minutes)

# Example usage
py .\main.py --topic Water --subtopics_amount 5 --length_minutes 10

Examples

Here you can see an example output for the topic Python Programming Language, two sub topics and 5 min length.

Slide One img.png

Slide Two img_1.png

# Example usage
py .\main.py --topic "Python Programming Language" --subtopics_amount 2 --length_minutes 5

Contributing

Feel free to contribute or report any issues or wanted features.

# Contributing

1. Fork the project
2. Create your feature branch (`git checkout -b feature/YourFeature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin feature/YourFeature`)
5. Create a new Pull Request

License

Specify the project's license.

MIT License