Python Package Exercise

Funtasks: A Task Generating Package

This package was created by generally following the Packaging Python Projects guide, with the addition of pipenv for virtual environment management.

Overview

Funtasks is a simple and fun task management package designed to help you add, complete, and randomly select tasks. It includes features for adding tasks with urgency levels, marking tasks as complete, and generating random tasks or daily goals based on your available time.

Team Members

Natalie Ovcarov
Jun Li
Daniel Brito
Alvaro Martinez

Link to Our Package on PyPI

PyPI package Link

Functions Overview

• add_task(task_name: str, urgency: int) -> str

  • Description: Adds a new task to the list with a specified urgency level.
  • Parameters:
    • task_name: The name of the task to add.
    • urgency: An integer representing the urgency level (1–5, with 5 being the most urgent).
  • Returns: A confirmation message upon successful addition.
  • Raises: ValueError if the task already exists.
  • Example:

    add_task("Do laundry", 3)
    

• complete_task(task_name: str) -> str

  • Description: Marks a task as completed.
  • Parameters:
    • task_name: The name of the task to complete.
  • Returns: A confirmation message or a message indicating the task doesn't exist.
  • Example:

    complete_task("Do laundry")
    

• random_task() -> str

  • Description: Retrieves a random task from the list.
  • Returns: The name of a random task or a message indicating there are no tasks.
  • Example:

    random_task()
    

• random_daily_goal(available_time: int) -> str

  • Description: Suggests a task based on the available time.
  • Parameters:
    • available_time: Time available in minutes (used to determine task urgency).
  • Returns: A task that fits the time constraint or a message indicating no tasks are suitable.
  • Example:

    random_daily_goal(25)
    

How to Install and Use This Package

Platform Configuration

• Windows users: Use python and pip commands instead of python3 and pip3 where necessary.

  pip install pipenv
  python your_program_filename.py
  

• macOS/Linux users: Ensure Python 3 is installed and use python3.

  pip3 install pipenv
  python3 your_program_filename.py
  

1. Install pipenv (if not already installed):

   pip3 install pipenv
   

2. Install the package:

   pip3 install funtasks
   

3. Activate the virtual environment:

   pipenv shell
   

4. Create a Python program file to import and use the package:

   from funtasks.tasks import add_task, complete_task, random_task, random_daily_goal
   add_task("Tell a joke", 2)
   complete_task("Tell a joke")
   print(random_task())
   print(random_daily_goal(25))
   

5. Run the program:

   python3 your_program_filename.py
   

6. Exit the virtual environment:

   exit
   

Alternative: Run the Package Directly

1. Create and activate a pipenv virtual environment.
2. Run the package directly:

   python3 -m funtasks
   

3. Exit the virtual environment:

   exit
   

How to Run Unit Tests

We've included three unit tests for each function in the funtasks package. To run these tests:

1. Install pytest in the virtual environment:

   pipenv install pytest
   

2. Run the tests from the main project directory:

   python3 -m pytest
   

3. Verify all tests pass to ensure correct functionality.

How to Contribute to Funtasks

Prerequisites

Make sure you have Python 3.9 or higher installed:

python3 --version

1. Clone the repository:

   git clone https://github.com/software-students-fall2024/3-python-package-java_and_the_scripts_.git
   

2. Enter the directory:

   cd 3-python-package-java_and_the_scripts_
   

3. Set up a virtual environment using pipenv:

   pipenv install --dev
   

4. Activate the virtual environment:

   pipenv shell
   

5. Modify and run the file:

   python -m funtasks
   

   If you want to run a specific file (like tasks.py), use:

   python funtasks/tasks.py
   

6. Run tests:

   pipenv run pytest
   

7. Build the package:

   python3 -m build
   

8. Exit the virtual environment:

   exit
   

Continuous Integration

This project has a continuous integration workflow that builds and runs unit tests automatically with every push to GitHub.