GrammaticalEvolutionTools 1.1.0a1__tar.gz → 1.1.0.dev3__tar.gz

{grammaticalevolutiontools-1.1.0a1 → grammaticalevolutiontools-1.1.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GrammaticalEvolutionTools
-Version: 1.1.0a1
+Version: 1.1.0.dev3
 Summary: This package contains several tools for quickly setting up worlds and agents for Grammatical Evolution Projects.
 License: MIT
 License-File: LICENSE
@@ -19,24 +19,25 @@ Description-Content-Type: text/markdown
 
 # Grammatical Evolution Tools
 
-[![Python Version](https://img.shields.io/badge/python-3.14+-blue)](https://www.python.org/downloads/)
-[![Version](https://img.shields.io/badge/Version-1.1.0a1-blue)](https://github.com/n-smith-byu/GrammaticalEvolutionTools)
+[![Python Version](https://img.shields.io/badge/python-3.13+-blue)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/GrammaticalEvolutionTools)](https://pypi.org/project/GrammaticalEvolutionTools/)
 [![GitHub License](https://img.shields.io/badge/License-MIT-green)](https://github.com/n-smith-byu/GrammaticalEvolutionTools/blob/main/LICENSE)
-[![Documentation](https://img.shields.io/badge/docs-under--construction-yellow)](https://img.shields.io/badge/docs-under--construction-yellow)
-![Tests](https://img.shields.io/badge/tests-under--construction-yellow)
+![Docs](https://img.shields.io/badge/docs-coming--soon-yellow)
+![Tests](https://img.shields.io/badge/tests-in--development-yellow)
 
 
----
-
 ## Table of Contents
 * [Introduction](#introduction)
 * [Features](#features)
+    * [Currently Available](#currently-available)
+    * [Coming Soon](#coming-soon) 
 * [Installation](#installation)
-    * [Prerequisites](#prerequisites)
-    * [Core Package](#core-package)
-    * [For Notebooks and Examples](#for-notebooks-and-examples)
-    * [For Development](#for-development)
-* [Quick Start / Usage](#quick-start--usage)
+    * [PyPI](#pypi)
+    * [Local Development](#local-development)
+        * [Prerequisites](#prerequisites)
+        * [Core Package](#core-package)
+        * [For Notebooks and Examples](#for-notebooks-and-examples)
+        * [For Development](#for-development-tests-and-docs)
 * [Examples](#examples)
 * [Running Tests](#running-tests)
 * [Documentation](#documentation)
@@ -66,9 +67,32 @@ Whether you're building complex simulation environments or simple test cases, `g
 
 ## Installation
 
-Since this package is not yet published to PyPI, you will need to clone the repository and install it locally.
+### PyPI
+
+This package is available on PyPI. You can install it with:
+```bash
+pip install GrammaticalEvolutionTools
+```
+
+For pre-releases, you may need to specify the version:
+```bash
+pip install GrammaticalEvolutionTools==<VERSION>
+```
+
+After installation:
 
-### Prerequisites
+```python
+import getools
+
+from getools.worlds.grid_world import GridWorld
+from getools.grammars import Grammar
+...
+world = GridWorld(...)
+```
+
+### Local Development
+
+#### Prerequisites
 
 This project uses [Poetry](https://python-poetry.org/) for dependency management and packaging. Before installing the package, ensure you have Poetry installed on your system.
 
@@ -85,42 +109,35 @@ pipx install poetry
 
 You can find more detailed installation instructions for Poetry on their official website: [Poetry Installation Guide](https://python-poetry.org/docs/#installation)
 
+---
 
-### Core Package
+#### Core Package
 
 To install the core package with only its essential dependencies (for integrating it into your own projects):
 
 ```bash
-# Clone the repository first
-git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-cd getools
+# Clone the repository
+git clone https://github.com/n-smith-byu/GrammaticalEvolutionTools.git
+cd GrammaticalEvolutionTools
 
-# Install the core package in editable mode
+# Install the core package
 poetry install
 ```
 
-### To Run Notebooks and Examples
+#### For Notebooks and Examples
 
 If you plan to explore the provided examples or run the Jupyter notebooks, you'll need to install the package with the `examples` dependency group.
 
 ```bash
-# If you haven't already, clone the repository and navigate into it
-# git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-# cd getools
-
 # Install the package with examples dependencies
 poetry install --with examples
 ```
 
-### For Development
+#### For Development (Tests and Docs)
 
 If you intend to modify the code, run tests, or build the documentation, install with the `dev` dependency group.
 
 ```bash
-# If you haven't already, clone the repository and navigate into it
-# git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-# cd getools
-
 # Install in editable mode with dev dependencies
 poetry install --with dev
 ```
@@ -190,3 +207,4 @@ This project is licensed under the [MIT License](https://github.com/n-smith-byu/
 
 ---
 
+

{grammaticalevolutiontools-1.1.0a1 → grammaticalevolutiontools-1.1.0.dev3}/README.md

@@ -1,23 +1,24 @@
 # Grammatical Evolution Tools
 
-[![Python Version](https://img.shields.io/badge/python-3.14+-blue)](https://www.python.org/downloads/)
-[![Version](https://img.shields.io/badge/Version-1.1.0a1-blue)](https://github.com/n-smith-byu/GrammaticalEvolutionTools)
+[![Python Version](https://img.shields.io/badge/python-3.13+-blue)](https://www.python.org/downloads/)
+[![PyPI](https://img.shields.io/pypi/v/GrammaticalEvolutionTools)](https://pypi.org/project/GrammaticalEvolutionTools/)
 [![GitHub License](https://img.shields.io/badge/License-MIT-green)](https://github.com/n-smith-byu/GrammaticalEvolutionTools/blob/main/LICENSE)
-[![Documentation](https://img.shields.io/badge/docs-under--construction-yellow)](https://img.shields.io/badge/docs-under--construction-yellow)
-![Tests](https://img.shields.io/badge/tests-under--construction-yellow)
+![Docs](https://img.shields.io/badge/docs-coming--soon-yellow)
+![Tests](https://img.shields.io/badge/tests-in--development-yellow)
 
 
----
-
 ## Table of Contents
 * [Introduction](#introduction)
 * [Features](#features)
+    * [Currently Available](#currently-available)
+    * [Coming Soon](#coming-soon) 
 * [Installation](#installation)
-    * [Prerequisites](#prerequisites)
-    * [Core Package](#core-package)
-    * [For Notebooks and Examples](#for-notebooks-and-examples)
-    * [For Development](#for-development)
-* [Quick Start / Usage](#quick-start--usage)
+    * [PyPI](#pypi)
+    * [Local Development](#local-development)
+        * [Prerequisites](#prerequisites)
+        * [Core Package](#core-package)
+        * [For Notebooks and Examples](#for-notebooks-and-examples)
+        * [For Development](#for-development-tests-and-docs)
 * [Examples](#examples)
 * [Running Tests](#running-tests)
 * [Documentation](#documentation)
@@ -47,9 +48,32 @@ Whether you're building complex simulation environments or simple test cases, `g
 
 ## Installation
 
-Since this package is not yet published to PyPI, you will need to clone the repository and install it locally.
+### PyPI
+
+This package is available on PyPI. You can install it with:
+```bash
+pip install GrammaticalEvolutionTools
+```
+
+For pre-releases, you may need to specify the version:
+```bash
+pip install GrammaticalEvolutionTools==<VERSION>
+```
+
+After installation:
 
-### Prerequisites
+```python
+import getools
+
+from getools.worlds.grid_world import GridWorld
+from getools.grammars import Grammar
+...
+world = GridWorld(...)
+```
+
+### Local Development
+
+#### Prerequisites
 
 This project uses [Poetry](https://python-poetry.org/) for dependency management and packaging. Before installing the package, ensure you have Poetry installed on your system.
 
@@ -66,42 +90,35 @@ pipx install poetry
 
 You can find more detailed installation instructions for Poetry on their official website: [Poetry Installation Guide](https://python-poetry.org/docs/#installation)
 
+---
 
-### Core Package
+#### Core Package
 
 To install the core package with only its essential dependencies (for integrating it into your own projects):
 
 ```bash
-# Clone the repository first
-git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-cd getools
+# Clone the repository
+git clone https://github.com/n-smith-byu/GrammaticalEvolutionTools.git
+cd GrammaticalEvolutionTools
 
-# Install the core package in editable mode
+# Install the core package
 poetry install
 ```
 
-### To Run Notebooks and Examples
+#### For Notebooks and Examples
 
 If you plan to explore the provided examples or run the Jupyter notebooks, you'll need to install the package with the `examples` dependency group.
 
 ```bash
-# If you haven't already, clone the repository and navigate into it
-# git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-# cd getools
-
 # Install the package with examples dependencies
 poetry install --with examples
 ```
 
-### For Development
+#### For Development (Tests and Docs)
 
 If you intend to modify the code, run tests, or build the documentation, install with the `dev` dependency group.
 
 ```bash
-# If you haven't already, clone the repository and navigate into it
-# git clone [https://github.com/n-smith-byu/getools.git](https://github.com/n-smith-byu/GrammaticalEvolutionTools.git)
-# cd getools
-
 # Install in editable mode with dev dependencies
 poetry install --with dev
 ```
@@ -170,3 +187,4 @@ This project is licensed under the [MIT License](https://github.com/n-smith-byu/
 
 
 ---
+

{grammaticalevolutiontools-1.1.0a1 → grammaticalevolutiontools-1.1.0.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "GrammaticalEvolutionTools"
-version = "1.1.0a1"
+version = "1.1.0.dev3"
 description = "This package contains several tools for quickly setting up worlds and agents for Grammatical Evolution Projects."
 authors = ["Nick Smith <nicholas.smith0014@gmail.com>"]
 license = "MIT"