# Maze Solver Documentation
## Descripción
Esta biblioteca permite crear, resolver y visualizar laberintos. Incluye métodos para cargar un laberinto desde un archivo, resolverlo utilizando algoritmos como DFS (Depth-First Search) y BFS (Breadth-First Search), y visualizar tanto el laberinto original como el resuelto.
## Instalación
Para instalar las dependencias necesarias, ejecuta el siguiente comando:
```bash
pip install -r requirements.txt
```
## Uso
### Leer un laberinto desde un archivo
```python
import maze
# Leer el laberinto
maze_instance = maze.read("ruta/al/archivo/maze.txt")
maze_instance.show(title="Maze Original", label=True)
```
### Resolver el laberinto
```python
# Resolver el laberinto usando DFS
solved_maze = maze_instance.solve(method="DFS")
# Mostrar el laberinto resuelto
solved_maze.show(title="Solved Maze (DFS)", label=True)
```
### Obtener información sobre la solución
```python
# Número de pasos
print(solved_maze.info())
# Pasos del camino resuelto
print(solved_maze.steps())
```
## Requisitos
Para utilizar la biblioteca, asegúrate de tener instaladas las siguientes dependencias:
- `numpy==1.23.5`
- `matplotlib==3.6.2`
Estas dependencias se pueden instalar ejecutando:
```bash
pip install -r requirements.txt
```
## Créditos
Desarrollado por: Pablo Álvaro Hidalgo
Raw data
{
"_id": null,
"home_page": "https://github.com/pabblo2000/pybyrinth",
"name": "pybyrinth",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "maze, labyrinth, pathfinding, search, DFS, BFS",
"author": "Pablo \u00c1lvaro Hidalgo",
"author_email": "palvaroh2000@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b8/fe/76011a59ea1998b903e4549afdb43d51b1214189acc7efe9126bb2699420/pybyrinth-1.2.2.tar.gz",
"platform": null,
"description": "\r\n# Maze Solver Documentation\r\n\r\n## Descripci\u00f3n\r\n\r\nEsta biblioteca permite crear, resolver y visualizar laberintos. Incluye m\u00e9todos para cargar un laberinto desde un archivo, resolverlo utilizando algoritmos como DFS (Depth-First Search) y BFS (Breadth-First Search), y visualizar tanto el laberinto original como el resuelto.\r\n\r\n## Instalaci\u00f3n\r\n\r\nPara instalar las dependencias necesarias, ejecuta el siguiente comando:\r\n\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n## Uso\r\n\r\n### Leer un laberinto desde un archivo\r\n\r\n```python\r\nimport maze\r\n\r\n# Leer el laberinto\r\nmaze_instance = maze.read(\"ruta/al/archivo/maze.txt\")\r\nmaze_instance.show(title=\"Maze Original\", label=True)\r\n```\r\n\r\n### Resolver el laberinto\r\n\r\n```python\r\n# Resolver el laberinto usando DFS\r\nsolved_maze = maze_instance.solve(method=\"DFS\")\r\n\r\n# Mostrar el laberinto resuelto\r\nsolved_maze.show(title=\"Solved Maze (DFS)\", label=True)\r\n```\r\n\r\n### Obtener informaci\u00f3n sobre la soluci\u00f3n\r\n\r\n```python\r\n# N\u00famero de pasos\r\nprint(solved_maze.info())\r\n\r\n# Pasos del camino resuelto\r\nprint(solved_maze.steps())\r\n```\r\n\r\n## Requisitos\r\n\r\nPara utilizar la biblioteca, aseg\u00farate de tener instaladas las siguientes dependencias:\r\n\r\n- `numpy==1.23.5`\r\n- `matplotlib==3.6.2`\r\n\r\nEstas dependencias se pueden instalar ejecutando:\r\n\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n## Cr\u00e9ditos\r\n\r\nDesarrollado por: Pablo \u00c1lvaro Hidalgo\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for creating, solving, and visualizing mazes using Depth-First Search (DFS) and Breadth-First Search (BFS) algorithms.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/pabblo2000/pybyrinth"
},
"split_keywords": [
"maze",
" labyrinth",
" pathfinding",
" search",
" dfs",
" bfs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8fe76011a59ea1998b903e4549afdb43d51b1214189acc7efe9126bb2699420",
"md5": "e74d482613415a3b57be6bcc13e09d50",
"sha256": "bd66eb17b90ad5162d431b558e467d5ed5276d45a9683c31e3800bac6bc8e5df"
},
"downloads": -1,
"filename": "pybyrinth-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "e74d482613415a3b57be6bcc13e09d50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9019,
"upload_time": "2024-10-12T22:27:34",
"upload_time_iso_8601": "2024-10-12T22:27:34.652062Z",
"url": "https://files.pythonhosted.org/packages/b8/fe/76011a59ea1998b903e4549afdb43d51b1214189acc7efe9126bb2699420/pybyrinth-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 22:27:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pabblo2000",
"github_project": "pybyrinth",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": [
[
"==",
"1.23.5"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.6.2"
]
]
}
],
"lcname": "pybyrinth"
}
JSON
