snacktime-trial1

.github/workflows/pr_test.yaml

@@ -0,0 +1,48 @@
+name: Tests
+on:
+  push:
+    branches: [pipfile-experiment]
+    tags: ['*']
+  pull_request:
+    branches: [pipfile-experiment]
+    types: [opened, synchronize, reopened, closed]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ["3.9","3.10","3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python, pipenv and Pipfile packages
+        uses: kojoru/prepare-pipenv@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Turn on 'editable' mode
+        run: |
+          pipenv install -e .
+      - name: Test with pytest
+        run: |
+          pipenv install pytest
+          pipenv --venv
+          pipenv run python -m pytest
+  deliver:
+    if: github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/')
+    needs: [build]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python, pipenv and Pipfile packages
+        uses: kojoru/prepare-pipenv@v1
+      - name: Build package
+        run: |
+          pipenv install build
+          pipenv run python -m build .
+      - name: Publish to PyPI test server
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          repository-url: https://upload.pypi.org/legacy/

Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+pytest = "*"
+build = "*"
+twine = "*"
+
+[requires]
+python_version = "3.9"
+
+[scripts]
+snacktime = "python -m snacktime"

README.md

@@ -1,3 +1,148 @@
-# Python Package Exercise
+# 🥗 snacktime 
 
-An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details.
+**Build & Tests**  
+Python 3.09  ![Python 3.09](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.09)  
+Python 3.10  ![Python 3.10](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.10)  
+Python 3.11  ![Python 3.11](https://github.com/swe-students-fall2025/3-python-package-team_solace/actions/workflows/pr_test.yaml/badge.svg?branch=pipfile-experiment&label=Python%203.11)  
+
+
+
+A lightweight and fun Python package that helps you pick a **random snack**, **vegetable**, **sweet treat**, or even generate a **simple salad recipe**.  
+Originally created as part of the Software Engineering Fall 2025 team project — this package demonstrates Python packaging, publishing, and CI automation.
+
+---
+
+## 📦 PyPI Project
+
+🔗 **Link:** [https://pypi.org/project/snacktime/](https://pypi.org/project/snacktime/)  
+
+---
+
+## 🚀 Installation
+
+You can install directly from PyPI using pip:
+
+```bash
+pip install snacktime
+```
+
+---
+
+## 🧩 Usage
+
+Once installed, simply import and call any of the available functions:
+
+```python
+import snacktime
+
+print(snacktime.random_snack())
+print(snacktime.random_vegetable())
+print(snacktime.random_treat())
+print(snacktime.recipe_salad(serves=2, dressing="balsamic"))
+```
+
+### 🧾 Example Output
+
+```bash
+granola bar
+spinach
+cupcake
+
+Simple Green Salad
+Serves: 2
+
+Ingredients
+-----------
+- 4 cups mixed greens
+- 2 cups chopped vegetables (e.g., cucumber, tomato, carrot)
+- 4 tbsp nuts or seeds (optional)
+- Salt & pepper to taste
+- Dressing: 4 tbsp olive oil, 2 tbsp balsamic vinegar, pinch of salt
+
+Steps
+-----
+1) Toss greens and chopped veggies in a bowl.
+2) Whisk dressing separately, then drizzle over salad.
+3) Sprinkle nuts/seeds. Season with salt & pepper. Toss and serve.
+```
+
+
+Or, if preferred, snacktime can be called from the command line once installed:
+```bash
+$ pipenv run snacktime snack
+pretzels
+$ pipenv run snacktime treat
+churro
+$ pipenv run snacktime vegetable
+spinach
+$ pipenv run snacktime recipe
+Simple Green Salad
+Serves: 2
+
+Ingredients
+----------
+- 4 cups mixed greens
+- 2 cup chopped vegetables (e.g., cucumber, tomato, carrot)
+- 4 tbsp nuts or seeds (optional)
+- Salt & pepper to taste
+- Dressing: 4 tbsp olive oil, 2 tbsp balsamic vinegar, pinch of salt
+
+Steps
+-----
+1) Toss greens and chopped veggies in a bowl.
+2) Whisk dressing separately, then drizzle over salad.
+3) Sprinkle nuts/seeds. Season with salt & pepper. Toss and serve.
+```
+
+Make sure not to snack too much!
+
+
+---
+
+## ✨ Features
+
+- 🍎 **`random_snack()`** — pick a random healthy or quick snack  
+- 🥦 **`random_vegetable()`** — choose a random vegetable  
+- 🍩 **`random_treat()`** — get a random dessert idea  
+- 🥗 **`recipe_salad()`** — generate a simple, customizable salad recipe  
+
+---
+
+## 👥 Team Solace
+
+- **Member**: [funfigwat](https://github.com/funfig16), [qiexian-mf](https://github.com/qiexian-mf), [ems9856-lgtm](https://github.com/ems9856-lgtm), [hanqigui](https://github.com/hanqigui), [jawarbx](https://github.com/jawarbx)
+
+---
+
+## 🧠 Notes
+
+- Tested with **Python 3.9+** on macOS and Linux.  
+- All random functions can be made deterministic with a `seed` argument.  
+  ```python
+  snacktime.random_snack(seed=42)
+  ```
+- Supports CLI and programmatic use.
+
+---
+
+## 🧑‍💻 Project Details
+
+| Field | Description |
+|-------|-------------|
+| **Package Name** | `snacktime` |
+| **Author** | Team Solace |
+| **License** | GPL 3.0 |
+| **Language** | Python 3.9+ |
+| **PyPI Page** | [https://pypi.org/project/snacktime/](https://pypi.org/project/snacktime/)  
+
+---
+
+## 🥳 Credits
+
+Developed by **Team Solace** for *Software Engineering (Fall 2025)*  
+as part of the Python Package exercise.  
+This project demonstrates collaboration, testing, automation, and packaging best practices.
+
+---
+
+**Enjoy your snacks and code responsibly，thank you! 🍪🥗🍫**

examples/demo.py

@@ -0,0 +1,15 @@
+# examples/demo.py
+
+from snacktime import random_snack, random_treat, random_vegetable, recipe_salad
+
+def main():
+    print("=== snacktime demo ===")
+    print("snack:", random_snack(seed=1))
+    print("treat:", random_treat(seed=2))
+    print("vegetable:", random_vegetable(seed=3))
+
+    print("\n--- salad recipe ---")
+    print(recipe_salad(serves=3, dressing="lemon"))
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "snacktime"
+version = "0.5.1"
+description = "CLI that gives a random snack, a simple salad recipe, a random vegetable, or a sweet treat."
+authors = [
+    {name="Ezra Shapiro", email="ems9856@nyu.edu"},
+    {name="Athena Luo", email="athenaluoxy@gmail.com"},
+    {name="Jasir Nawar", email="jn2691@nyu.edu"},
+    {name="Hanqi Gui", email="hg2542@nyu.edu"},
+    {name="Kaiyuan Wu", email="wkyklmf@gmail.com"}
+]
+
+maintainers = [
+    {name="Ezra Shapiro", email="ems9856@nyu.edu"},
+    {name="Athena Luo", email="athenaluoxy@gmail.com"},
+    {name="Jasir Nawar", email="jn2691@nyu.edu"},
+    {name="Hanqi Gui", email="hg2542@nyu.edu"},
+    {name="Kaiyuan Wu", email="wkyklmf@gmail.com"}
+]
+
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.scripts]
+snacktime = "snacktime.__main__:main"
+
+[project.optional-dependencies]
+dev = ['pytest']
+
+[project.urls]
+"Homepage" = "https://github.com/swe-students-fall2025/3-python-package-team_solace"
+"Repository" = "https://github.com/swe-students-fall2025/3-python-package-team_solace.git"
+"Bug Tracker" = "https://github.com/swe-students-fall2025/3-python-package-team_solace/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["snacktime*"]

snacktime/__init__.py

@@ -0,0 +1,10 @@
+__version__ = "0.2.0"
+
+from .core import (
+    random_snack,
+    random_vegetable,
+    random_treat,
+    recipe_salad,
+)
+
+__all__ = ["random_snack", "random_vegetable", "random_treat", "recipe_salad"]

snacktime/__main__.py

@@ -0,0 +1,55 @@
+import sys
+from . import random_snack, random_vegetable, random_treat, recipe_salad, __version__
+
+USAGE = """\
+snacktime v{v}
+
+Usage:
+  snacktime snack                # random snack
+  snacktime recipe [--serves N] [--dressing NAME]
+  snacktime vegetable [--seed N] # random vegetable
+  snacktime treat [--seed N]     # random sweet treat
+
+Options:
+  --seed N       Deterministic selection for snack/vegetable/treat (default: none)
+  --serves N     Servings for the salad recipe (default: 2)
+  --dressing NAME  lemon | balsamic | olive (default: balsamic)
+"""
+
+def main(argv=None):
+    argv = list(sys.argv[1:] if argv is None else argv)
+    if not argv:
+        print(USAGE.format(v=__version__))
+        return 0
+
+    cmd = argv[0].lower().strip()
+    args = argv[1:]
+
+    # parse simple flags
+    def read_flag(name, cast=int, default=None):
+        if name in args:
+            i = args.index(name)
+            try:
+                return cast(args[i+1])
+            except Exception:
+                raise SystemExit(f"Invalid value for {name}")
+        return default
+
+    seed = read_flag("--seed", int, None)
+    serves = read_flag("--serves", int, 2)                  
+    dressing = read_flag("--dressing", str, "balsamic")     
+
+    if cmd == "snack":
+        print(random_snack(seed=seed)); return 0
+    if cmd == "vegetable":
+        print(random_vegetable(seed=seed)); return 0
+    if cmd == "treat":
+        print(random_treat(seed=seed)); return 0
+    if cmd == "recipe":
+        print(recipe_salad(serves=serves, dressing=dressing)); return 0
+
+    print(USAGE.format(v=__version__))
+    return 1
+
+if __name__ == "__main__":
+    raise SystemExit(main())