Explain

.github/workflows/build.yml

@@ -0,0 +1,61 @@
+name: CI / CD - Morse Code
+
+on: 
+  pull_request:
+    branches: [pipfile-experiment]
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python and Pipenv
+        uses: kojoru/prepare-pipenv@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+
+      - name: Turn on 'editable' mode
+        run: |
+          pipenv install -e .
+
+      - name: Run pytest
+        run: |
+          pipenv install pytest
+          pipenv --venv
+          pipenv run python -m pytest
+
+  deliver:
+    if: github.event_name != 'pull_request'
+    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
+        with:
+          python-version: "3.10"
+
+      - name: Build package
+        run: |
+          pipenv install build
+          pipenv run python -m build .
+
+      #  publish to PyPI Test server
+      # - name: Publish to TestPyPI
+      #   uses: pypa/gh-action-pypi-publish@release/v1
+      #   with:
+      #     password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+      #     repository-url: https://test.pypi.org/legacy/

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pytest = "*"
+morse-code = {file = ".", editable = true}
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"

README.md

@@ -1,3 +1,21 @@
 # Python Package Exercise
 
 An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details.
+
+## morseify - Overview
+morseify is a lightweight Python package that brings the world of Morse code to anyone curious about how digital communication began. It offers intuitive encode and decode functionality to translate between English text and Morse code, along with built-in tools for text normalization and message validation.
+
+For a more interactive experience, morseify also includes a quiz mode that generates random Morse code challenges for users to decode, making it both an educational and entertaining way to explore the fundamentals of encoded communication.
+
+## Features
+- Encode English text to Morse code  
+- Decode Morse code to English text  
+- Normalize text and Morse sequences  
+- Validate Morse message formats  
+- Explain message steps
+- Quiz mode to test Morse knowledge 
+
+## Installation / Setup
+
+<!-- TODO: Update once package is published to PyPI or ready for local install.
+Include both PyPI and local development setup -->

examples/demo.py

@@ -0,0 +1 @@
+

pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "morse_code"
+version = "0.1.0"
+description = "A Python package for encoding and decoding Morse code."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "Team Lumen" }]
+keywords = ["python", "morse code", "encoder", "decoder"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent"
+]
+
+[project.urls]
+Homepage = "https://github.com/swe-students-fall2025/3-python-package-team_lumen"
+Issues = "https://github.com/swe-students-fall2025/3-python-package-team_lumen/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.scripts]
+morseify = "morseify.cli:cli"

src/morseify/__init__.py

@@ -0,0 +1,27 @@
+"""
+Morse Code Package
+A Python package for encoding and decoding Morse code with additional utilities.
+"""
+
+from morseify.core import (
+    encode,
+    decode,
+    is_valid
+)
+from morseify.normalize import (
+    normalize_text,
+    normalize_code
+)
+from morseify.explain import explain
+from morseify.quiz import quiz
+
+__all__ = [
+    'encode',
+    'decode',
+    'is_valid',
+    'normalize_text',
+    'normalize_code',
+    'explain',
+    'quiz'
+]
+

src/morseify/__main__.py

@@ -0,0 +1,46 @@
+from .core import encode, decode, is_valid
+from .explain import explain
+from .quiz import quiz
+
+
+def main():
+    print("Morse Code Encode/Decode Test")
+    # Test cases
+    test_cases = [
+        "HELLO",
+        "HELLO WORLD",
+        "SOS",
+        "PYTHON",
+        "123",
+        "A1B2C3"
+    ]
+
+    for text in test_cases:
+        encoded = encode(text)
+        decoded = decode(encoded)
+
+        print(f"\nOriginal: '{text}'")
+        print(f"Encoded : '{encoded}'")
+        print(f"Decoded : '{decoded}'")
+
+        # Check if round-trip works
+        if decoded == text:
+            print("✓ Round-trip successful!")
+        else:
+            print(f"✗ Round-trip failed! Expected: '{text}'")
+
+    # Example of explain feature with user input
+    print("Explain Feature")
+    user_morse = input("Enter morse code to explain: ").strip()
+    if user_morse:
+        explanation = explain(user_morse)
+        print(explanation)
+    else:
+        print("No input provided. Using example:")
+        example_morse = ".... . .-.. .-.. --- / .-- --- .-. .-.. -.."
+        explanation = explain(example_morse)
+        print(explanation)
+
+
+if __name__ == "__main__":
+    main()

src/morseify/cli.py

@@ -0,0 +1,41 @@
+"""
+Command-line interface for morseify.
+"""
+
+import sys
+from morseify.core import encode, decode, is_valid
+
+
+def cli():
+    """
+    Command-line interface for morseify.
+    Auto-detects whether input is text (encode) or morse code (decode).
+
+    Usage:
+        morseify "HELLO"           # Encodes text to morse code
+        morseify ".... . .-.. .-.. ---"  # Decodes morse code to text
+    """
+    if len(sys.argv) < 2:
+        print("Usage: morseify <text or morse code>")
+        print("Examples:")
+        print('  morseify "HELLO"')
+        print('  morseify ".... . .-.. .-.. ---"')
+        sys.exit(1)
+
+    # Join all arguments in case user passes multiple words
+    input_text = ' '.join(sys.argv[1:])
+
+    # Auto-detect: if input contains only morse characters (., -, /, space), decode it
+    # Otherwise, encode it
+    valid_morse_chars = {'.', '-', '/', ' '}
+    is_morse = all(char in valid_morse_chars for char in input_text) and input_text.strip()
+
+    if is_morse and is_valid(input_text):
+        # It's valid morse code, decode it
+        result = decode(input_text)
+        print(result)
+    else:
+        # It's text, encode it
+        result = encode(input_text)
+        print(result)
+