funnygpt 1.0.9

A package for project 3 for stuytowners

Contributors

Angela Tao

Luke Bernstein

Charles Hu

James Luo

Python Package: Foo Barstein

What is this package?

This package was created so you can have Professor Foo Barstein talk with you straight from your terminal. Professor Barstein can do four things - tell you a joke, tell you a haiku, tell you a compliment, and write you an email. Professor Barstein is a fictional character and powered by GPT-3.

DOCUMENTATION

Installation

1. Install the package by writing the following command in the shell: pip install funnygpt==1.0.8
2. set your openai api key using: export OPENAI_API_KEY=(your key)
3. Import the package by writing the following command in the shell: import funnygpt

• if this step does not work on your machine, try running: pip install --upgrade httpx httpcore

4. Run the following command in the shell to see some functionality!: funnygpt.gptchat('joke)

Features

1. gptchat: will take the role of Professor Foo Barstein and use ChatGPT to generate a joke, haiku, compliment, or an email so you don't have to be lonely in your terminal anymore.

2. cowtalk: will take the response from ChatGPT-3 and add "moo" every 3 words so you can talk with cows!

3. onewordperline: onewordperline will play around with how the text is displayed. Instead of left to right, you will be reading from top to bottom.

4. changepreset: changepreset will change how ChatGPT answers your question. Use this function to give ChatGPT a different role than Professor Foo Barstein!

Functions Documentation

default preset:

The preset can be changed, the default preset gives a setting for initial generation, the user can change preset by using changepreset() function.

preset = "You are the most chill cs professor in the world, Professor Foo Barstein. You are talking to me, a student in your class."

gptchat(type, preset)

Types: "joke", "haiku", "compliment", "email" example: test_joke=functions.gptchat("joke", "software engineers")

cowtalk(input)

example: test_cowtalk=functions.cowtalk(test_joke)

onewordperline(input)

example: test_onewordperline=functions.onewordperline(test_joke)

changepreset()

This function will enable the user the manually change the preset of the previous functions

How to Run demo

1. Set your OpenAI API Key by writing the following command in the shell: export OPENAI_API_KEY=(your key)
2. Run demo.py with the pipfile with the following command: pipenv run python demo.py

How to run tests

1. go to tests folder by writing the following command in the shell: cd tests
2. install all necessary packages by writing the following command in the shell: pip install openai pip install pytest
3. Set your OpenAI API Key by writing the following command in the shell: export OPENAI_API_KEY=(your key) 4.run tests by writing the following command in the shell: pytest test_functions.py