Commands

.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [pipfile-experiment]
+  pull_request:
+    branches: [pipfile-experiment]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      PIP_DISABLE_PIP_VERSION_CHECK: "1"
+      PIP_ROOT_USER_ACTION: "ignore"
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies and pytest
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          python -m pytest
+
+  build:
+    runs-on: ubuntu-latest
+    env:
+      PIP_DISABLE_PIP_VERSION_CHECK: "1"
+      PIP_ROOT_USER_ACTION: "ignore"
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          python -m build

.gitignore

@@ -147,3 +147,6 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# Project proposal file
+Project_3_proposal.docx

DEMO_COMMANDS.md

@@ -0,0 +1,77 @@
+# minecraft-textcraft Demo Commands
+
+## Quick Start
+```bash
+# Basic text rendering
+python -m minecraft_textcraft "HELLO"
+
+# With color
+python -m minecraft_textcraft "HELLO" --color GREEN
+
+# With command
+python -m minecraft_textcraft 'GET \\sword NOW'
+
+# With animation
+python -m minecraft_textcraft "HELLO" --effect type
+```
+
+## Text Rendering
+```bash
+python -m minecraft_textcraft "HELLO"
+python -m minecraft_textcraft "HELLO" --color GREEN
+python -m minecraft_textcraft "HELLO" --color RED
+python -m minecraft_textcraft "HELLO" --color BLUE
+python -m minecraft_textcraft "HELLO" --color YELLOW
+```
+
+## Commands
+```bash
+# List all commands
+python -m minecraft_textcraft --list
+
+# List categories
+python -m minecraft_textcraft --list-categories
+
+# Get command ASCII art
+python -m minecraft_textcraft --get sword
+python -m minecraft_textcraft --get earth
+
+# Command with color
+python -m minecraft_textcraft --get sword --color GREEN
+```
+
+## Text with Commands
+```bash
+# Text + command + color
+python -m minecraft_textcraft 'GET \\sword NOW' --color RED
+```
+
+## Animations
+```bash
+# Typewriter effect
+python -m minecraft_textcraft "HELLO" --effect type --color GREEN
+
+# Scroll effect
+python -m minecraft_textcraft "HELLO" --effect scroll --color BLUE
+
+# Wave effect
+python -m minecraft_textcraft "HELLO" --effect wave --color YELLOW
+```
+
+## Full Features Demo
+```bash
+# Text + command + animation + color + custom FPS
+python -m minecraft_textcraft 'GET \\sword NOW' --effect type --color GREEN --fps 20
+python -m minecraft_textcraft 'HELLO \\sword' --effect scroll --color RED
+
+```
+
+## Options
+- **Colors**: `RED`, `GREEN`, `BLUE`, `YELLOW`
+- **Effects**: `type`, `scroll`, `wave`
+- **FPS**: `10-30` (default: 12)
+
+## Help
+```bash
+python -m minecraft_textcraft --help
+```

Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+minecraft-textcraft = {extras = ["dev"], file = ".", editable = true}
+
+[dev-packages]
+pytest = "*"
+build = "*"
+
+[requires]
+python_version = "3"

README.md

@@ -1,3 +1,31 @@
-# Python Package Exercise
+[![CI](https://github.com/swe-students-fall2025/3-python-package-brio/actions/workflows/ci.yml/badge.svg)](https://github.com/swe-students-fall2025/3-python-package-brio/actions/workflows/ci.yml)
+# minecraft-textcraft
+
+A Python package that converts text into blocky Minecraft-style ASCII art, with support for special inline commands like \sword, \heart, and \diamond. Commands are center-aligned with text for a professional, visually appealing output.
+
+# Quickstart
+
+To setup:
+```bash
+git clone git@github.com:swe-students-fall2025/3-python-package-brio.git
+cd 3-python-package-brio
+pipenv shell
+pipenv install -e ".[dev]"
+```
+
+To build:
+```bash
+pipenv run python -m build
+```
+Artifacts will be in `dist/`.
+
+To run:
+```bash
+pipenv run minecraft-textcraft
+```
+
+To run tests:
+```bash
+pipenv run pytest
+```
 
-An exercise to create a Python package, build it, test it, distribute it, and use it. See [instructions](./instructions.md) for details.

pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "minecraft-textcraft"
+version = "0.0.2"
+description = "A Python package that converts text into blocky Minecraft-style ASCII art..."
+readme = "README.md"
+license = "GPL-3.0-or-later"
+requires-python = ">=3.7"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Intended Audience :: Education",
+  "Operating System :: OS Independent",
+]
+[project.optional-dependencies]
+dev = ["pytest", "build"]
+[project.scripts]
+minecraft-textcraft = "minecraft_textcraft.__main__:main"

src/minecraft_textcraft/__init__.py

@@ -0,0 +1,7 @@
+__version__ = "0.0.1"
+
+from .add import add
+from .colorize_ascii import colorize_ascii, Color
+from .commands import getCommand, getCommandByName, get_command, listCategories, listCommands
+from .animate import animate_typewriter, animate_scroll, animate_wave, play_animation
+from .render import render, renderTextOnly, renderCommandOnly, renderTextAndCommands