lifegrid 2.0.0__tar.gz

lifegrid-2.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,150 @@
+# LifeGrid Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in the LifeGrid
+project a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+### Positive Behavior
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+* Helping newcomers learn and grow
+* Celebrating the successes of others
+
+### Unacceptable Behavior
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing the project include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Learning and Exploration Context
+
+LifeGrid is designed to help people explore cellular automata and
+simulation concepts. We place special emphasis on:
+
+* Creating a welcoming environment for experimentation and curiosity
+* Encouraging questions about simulations, algorithms, and tooling
+* Treating mistakes as learning opportunities
+* Providing constructive, encouraging feedback
+* Respecting the privacy and safety of all participants
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at james@honey-badger.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome.
+
+**Consequence**: A private, written warning, providing clarity around the nature
+of the violation and an explanation of why the behavior was inappropriate. A
+public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved for a specified period of time. This
+includes avoiding interactions in community spaces as well as external
+channels. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq.
+
+## Contact
+
+For questions or concerns about this Code of Conduct, please contact:
+
+**James Temple**
+Honey Badger Universe
+Email: james@honey-badger.org
+Project: LifeGrid
+GitHub: https://github.com/James-HoneyBadger/LifeGrid

lifegrid-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Honey Badger Universe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lifegrid-2.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include CODE_OF_CONDUCT.md
+include requirements.txt
+recursive-include docs *
+recursive-include examples *

lifegrid-2.0.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: lifegrid
+Version: 2.0.0
+Summary: An interactive Tkinter-based workbench for experimenting with cellular automata
+Author-email: James-HoneyBadger <your-email@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/James-HoneyBadger/LifeGrid
+Project-URL: Repository, https://github.com/James-HoneyBadger/LifeGrid.git
+Project-URL: Documentation, https://github.com/James-HoneyBadger/LifeGrid/tree/master/docs
+Project-URL: Issues, https://github.com/James-HoneyBadger/LifeGrid/issues
+Keywords: cellular-automata,conway-game-of-life,tkinter,simulation,interactive
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: Pillow>=10.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pylint>=2.17.0; extra == "dev"
+Dynamic: license-file
+
+Repository: https://github.com/James-HoneyBadger/LifeGrid
+
+![Python Version](https://img.shields.io/badge/python-3.13%2B-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version](https://img.shields.io/badge/version-2.0.0-purple)
+git clone https://github.com/James-HoneyBadger/LifeGrid.git
+## LifeGrid
+
+An interactive Tkinter-based workbench for experimenting with cellular
+automata. The simulator ships with several classic rules, a custom B/S rule
+editor, drawing tools, and quick exporting to PNG.
+
+---
+
+## Highlights
+
+- **Multiple automata**: Conway's Life, HighLife, Immigration, Rainbow,
+  Langton's Ant, and fully custom life-like rules.
+- **Pattern presets** per mode for quick experimentation.
+- **Drawing tools** with toggle/pen/eraser modes plus symmetry helpers.
+- **Live statistics** for population deltas, peaks, and density.
+- **Save/Load** patterns as JSON and **export PNG** snapshots (when Pillow is
+  installed).
+- **Keyboard shortcuts**: `Space` (start/stop), `S` (step), `Left` (step back),
+  `C` (clear), `G` (toggle grid).
+
+---
+
+## Requirements
+
+- Python 3.13+
+- Tkinter (bundled with most Python installations)
+- NumPy 1.24+
+- SciPy 1.11+ (used for fast convolutions)
+- Pillow 10+ (optional, enables PNG export)
+
+Install dependencies from the repository root:
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+## Getting Started
+
+Run LifeGrid from the project root:
+
+```bash
+python src/main.py
+```
+
+Or use the helper script on Unix-like systems:
+
+```bash
+./run.sh
+```
+
+**Quick workflow**
+1. Pick a mode from the **Mode** dropdown.
+2. Choose a **Pattern** or draw on the canvas.
+3. Press **Start** (or hit `Space`) to run the simulation.
+4. Adjust **Speed**, drawing tools, and symmetry as needed.
+5. Use **Settings → Grid & View Settings…** for grid size, cell size, and grid
+  lines.
+6. Save/load/export from the **File** menu.
+
+---
+
+## Controls at a Glance
+
+| Action | UI Control | Shortcut |
+| --- | --- | --- |
+| Start/Stop simulation | Start button | `Space` |
+| Step one generation | Step button | `S` |
+| Step back one generation | Back button | `Left` |
+| Clear grid | Simulation → Clear | `C` |
+| Toggle grid lines | Settings → Toggle Grid | `G` |
+| Resize grid | Settings → Grid & View Settings… | – |
+| Apply custom B/S rule | Settings → Custom Rules… | – |
+
+Mouse interactions:
+
+- Click to toggle/draw/erase (depends on draw mode).
+- Drag while in Pen or Eraser to paint continuously.
+- Symmetry options mirror strokes across selected axes.
+
+---
+
+## Available Modes & Patterns
+
+- **Conway's Game of Life**: Classic Mix, Glider Gun, Spaceships, Oscillators,
+  Puffers, R-Pentomino, Acorn, Random Soup.
+- **HighLife (B36/S23)**: Replicator, Random Soup.
+- **Immigration Game**: Color Mix, Random Soup.
+- **Rainbow Game**: Rainbow Mix, Random Soup.
+- **Langton's Ant**: Empty.
+- **Custom Rules**: Random Soup starter pattern plus editable life-like B/S
+  rules via Settings.
+
+---
+
+## Project Structure
+
+```
+LifeGrid/
+├── src/
+│   ├── automata/        # Automaton implementations
+│   ├── gui/             # GUI modules (app, config, state, ui, rendering)
+│   └── main.py          # Thin entry point (delegates to gui.app)
+├── docs/                # README-style documentation
+├── examples/            # Sample patterns
+├── tests/               # Unit tests
+├── requirements.txt
+├── run.sh
+├── LICENSE
+└── README.md
+```
+
+Key GUI modules:
+
+- `gui/app.py`: High-level application orchestration.
+- `gui/ui.py`: Widget construction and event wiring.
+- `gui/state.py`: Mutable simulation state container.
+- `gui/config.py`: Shared constants and mode registries.
+- `gui/rendering.py`: Canvas drawing helpers.
+
+---
+
+## Development Notes
+
+- Launch tests with `pytest`. Current coverage targets the Conway automaton;
+  extending coverage for other modes is encouraged.
+- `flake8` enforces an 80-character line limit; run `flake8 src tests` before
+  committing.
+- To add a new automaton, implement it under `src/automata/`, expose it from
+  `automata/__init__.py`, and register it in `gui/config.py`.
+- The GUI is intentionally modular: prefer adding features in dedicated helper
+  modules rather than growing `gui/app.py`.
+
+Further details can be found in:
+
+- `docs/USER_GUIDE.md` – end-user walkthrough.
+- `docs/DEVELOPMENT.md` – contributor guidelines and code map.
+
+---
+
+## License
+
+This project is distributed under the MIT License. See the `LICENSE` file for
+full terms.

lifegrid-2.0.0/README.md

@@ -0,0 +1,152 @@
+Repository: https://github.com/James-HoneyBadger/LifeGrid
+
+![Python Version](https://img.shields.io/badge/python-3.13%2B-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Status](https://img.shields.io/badge/build-passing-brightgreen)
+![Version](https://img.shields.io/badge/version-2.0.0-purple)
+git clone https://github.com/James-HoneyBadger/LifeGrid.git
+## LifeGrid
+
+An interactive Tkinter-based workbench for experimenting with cellular
+automata. The simulator ships with several classic rules, a custom B/S rule
+editor, drawing tools, and quick exporting to PNG.
+
+---
+
+## Highlights
+
+- **Multiple automata**: Conway's Life, HighLife, Immigration, Rainbow,
+  Langton's Ant, and fully custom life-like rules.
+- **Pattern presets** per mode for quick experimentation.
+- **Drawing tools** with toggle/pen/eraser modes plus symmetry helpers.
+- **Live statistics** for population deltas, peaks, and density.
+- **Save/Load** patterns as JSON and **export PNG** snapshots (when Pillow is
+  installed).
+- **Keyboard shortcuts**: `Space` (start/stop), `S` (step), `Left` (step back),
+  `C` (clear), `G` (toggle grid).
+
+---
+
+## Requirements
+
+- Python 3.13+
+- Tkinter (bundled with most Python installations)
+- NumPy 1.24+
+- SciPy 1.11+ (used for fast convolutions)
+- Pillow 10+ (optional, enables PNG export)
+
+Install dependencies from the repository root:
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+## Getting Started
+
+Run LifeGrid from the project root:
+
+```bash
+python src/main.py
+```
+
+Or use the helper script on Unix-like systems:
+
+```bash
+./run.sh
+```
+
+**Quick workflow**
+1. Pick a mode from the **Mode** dropdown.
+2. Choose a **Pattern** or draw on the canvas.
+3. Press **Start** (or hit `Space`) to run the simulation.
+4. Adjust **Speed**, drawing tools, and symmetry as needed.
+5. Use **Settings → Grid & View Settings…** for grid size, cell size, and grid
+  lines.
+6. Save/load/export from the **File** menu.
+
+---
+
+## Controls at a Glance
+
+| Action | UI Control | Shortcut |
+| --- | --- | --- |
+| Start/Stop simulation | Start button | `Space` |
+| Step one generation | Step button | `S` |
+| Step back one generation | Back button | `Left` |
+| Clear grid | Simulation → Clear | `C` |
+| Toggle grid lines | Settings → Toggle Grid | `G` |
+| Resize grid | Settings → Grid & View Settings… | – |
+| Apply custom B/S rule | Settings → Custom Rules… | – |
+
+Mouse interactions:
+
+- Click to toggle/draw/erase (depends on draw mode).
+- Drag while in Pen or Eraser to paint continuously.
+- Symmetry options mirror strokes across selected axes.
+
+---
+
+## Available Modes & Patterns
+
+- **Conway's Game of Life**: Classic Mix, Glider Gun, Spaceships, Oscillators,
+  Puffers, R-Pentomino, Acorn, Random Soup.
+- **HighLife (B36/S23)**: Replicator, Random Soup.
+- **Immigration Game**: Color Mix, Random Soup.
+- **Rainbow Game**: Rainbow Mix, Random Soup.
+- **Langton's Ant**: Empty.
+- **Custom Rules**: Random Soup starter pattern plus editable life-like B/S
+  rules via Settings.
+
+---
+
+## Project Structure
+
+```
+LifeGrid/
+├── src/
+│   ├── automata/        # Automaton implementations
+│   ├── gui/             # GUI modules (app, config, state, ui, rendering)
+│   └── main.py          # Thin entry point (delegates to gui.app)
+├── docs/                # README-style documentation
+├── examples/            # Sample patterns
+├── tests/               # Unit tests
+├── requirements.txt
+├── run.sh
+├── LICENSE
+└── README.md
+```
+
+Key GUI modules:
+
+- `gui/app.py`: High-level application orchestration.
+- `gui/ui.py`: Widget construction and event wiring.
+- `gui/state.py`: Mutable simulation state container.
+- `gui/config.py`: Shared constants and mode registries.
+- `gui/rendering.py`: Canvas drawing helpers.
+
+---
+
+## Development Notes
+
+- Launch tests with `pytest`. Current coverage targets the Conway automaton;
+  extending coverage for other modes is encouraged.
+- `flake8` enforces an 80-character line limit; run `flake8 src tests` before
+  committing.
+- To add a new automaton, implement it under `src/automata/`, expose it from
+  `automata/__init__.py`, and register it in `gui/config.py`.
+- The GUI is intentionally modular: prefer adding features in dedicated helper
+  modules rather than growing `gui/app.py`.
+
+Further details can be found in:
+
+- `docs/USER_GUIDE.md` – end-user walkthrough.
+- `docs/DEVELOPMENT.md` – contributor guidelines and code map.
+
+---
+
+## License
+
+This project is distributed under the MIT License. See the `LICENSE` file for
+full terms.