magic-eight-ball 0.1.0

A fun and lighthearted Python package that emulates the classic Magic 8 Ball toy. This package allows users to ask questions and get random, playful responses. Built with rigorous software engineering practices, it serves as a joyful addition to any developer's toolbox.

Magic 8 Ball Python Package

A fun and lighthearted Python package that emulates the classic Magic 8 Ball toy. This package allows users to ask questions and get random, playful responses. Built with rigorous software engineering practices, it serves as a joyful addition to any developer's toolbox.

Features

This package includes the following functions:

• get_questions(language, count=0): Retrieve a list of sample questions.
• ask_question(language, question=""): Ask a question and receive a random response.
• shake_ball(language, shake_time=10): Shake the ball to get another response, with optional delay.
• get_answers(language, count=0): Retrieve a list of sample answers.

Installation

To install the Magic 8 Ball package, use pip:

pip install magic_eight

Usage

To use the package, import the functions you need:

from magic_eight import get_questions, ask_question, shake_ball, get_answers

# Example usage
print(get_questions("en", 2))  # Get two sample questions
print(ask_question("en"))      # Ask a random question
print(shake_ball("en", 1))     # Shake the ball with a 1-second delay
print(get_answers("en", 3))    # Get three sample answers

Functions

get_questions(language, count=0)

Retrieve a list of sample questions in the specified language.

• Parameters:

  • language (str): The language code (e.g., "en" for English).
  • count (int, optional): Number of questions to return. Default is 0, which returns all questions.

• Returns: list of questions.

Example

get_questions("en", 2)
# Output: ["Will I pass this class", "Will tomorrow be a snow day"]

ask_question(language, question="")

Ask a question and get a random answer.

• Parameters:

  • language (str): The language code.
  • question (str, optional): A specific question to ask. If empty, a random question is generated.

• Returns: tuple of (question, answer).

Example

ask_question("en", "Will I pass this class")
# Output: ("Will I pass this class", "Maybe")

shake_ball(language, shake_time=10)

Shake the ball to get another response to the previous question.

• Parameters:

  • language (str): The language code.
  • shake_time (int, optional): Time in seconds to simulate shaking. Default is 10.

• Returns: str answer.

Example

shake_ball("en", 1)
# Output: "Yes"

get_answers(language, count=0)

Retrieve a list of sample answers in the specified language.

• Parameters:

  • language (str): The language code.
  • count (int, optional): Number of answers to return. Default is 0, which returns all answers.

• Returns: list of answers.

Example

get_answers("en", 3)
# Output: ["Don't count on it", "Yes", "No"]

Running Tests

To run the unit tests for this package, use the following command:

PYTHONPATH=src python -m unittest discover -s src/tests

Contribution Guidelines

If you’d like to contribute:

1. Clone the repository and create a new feature branch.
2. Make your changes in the feature branch.
3. Create a pull request to merge into the main branch.
4. Ensure all tests pass by running:

   PYTHONPATH=src python -m unittest discover -s src/tests
   

5. Your code will be reviewed, and if everything is in order, it will be merged.

Developer Setup

• Install dependencies: Use pipenv to set up a virtual environment:

  pipenv install
  

• Run tests with pytest:

  pipenv run pytest
  

• Build the package:

  pipenv run python -m build
  

• Upload to PyPI:

  pipenv run twine upload dist/*
  

Example Program

Below is an example script demonstrating the use of all functions in this package:

from magic_eight import get_questions, ask_question, shake_ball, get_answers

# Get sample questions
print(get_questions("en", 2))

# Ask a question
print(ask_question("en", "Will I get the internship?"))

# Shake the ball for a new answer
print(shake_ball("en", 1))

# Get sample answers
print(get_answers("en", 3))

Contributors

• Natalie Trump
• Alexandra Mastrangelo

Links

• PyPI page for this package
• GitHub Repository