# textual-mandelbrot
## Introduction
This package provides a simple Mandelbrot set widget that can be used in
[Textual](https://textual.textualize.io/) applications, and also provides an
application that can be used to explore the classic Mandelbrot set in the
terminal.
## Installing
### pipx
The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
```sh
$ pipx install textual-mandelbrot
```
### Homebrew
The package is available via Homebrew. Use the following commands to install:
```sh
$ brew tap davep/homebrew
$ brew install textual-mandelbrot
```
## Running
Once installed you should be able to run the command `mandelexp` and the
application will run.
## Exploring
If you use `mandelexp` to run up the display, the following keys are
available:
| Keys | Action |
|-------------------|---------------------------------------|
| Up, w, k | Move up |
| Shift+Up, W, K | Move up slowly |
| Down, s, j | Move down |
| Shift+Down, S, J | Move down slowly |
| Left, a, h | Move left |
| Shift+Left, A, H | Move left slowly |
| Right, d, l | Move right |
| Shift+Right, D, L | Move right slowly |
| PageUp, ] | Zoom in |
| PageDown, [ | Zoom out |
| Ctrl+PageUp, } | Zoon in deeper |
| Ctrl+PageDown, { | Zoom out wider |
| *, Ctrl+Up | Increase "multobrot" |
| /, Ctrl+Down | Decrease "multibrot" |
| Ctrl+Shift+Up | Increase "multibrot" in smaller steps |
| Ctrl+Shift+Down | Decrease "multibrot" in smaller steps |
| Home | Center 0,0 in the display |
| , | Decrease iterations by 10 |
| < | Decrease iterations by 100 |
| . | Increase iterations by 10 |
| > | Increase iterations by 100 |
| Ctrl+r | Reset to initial state |
| Escape | Quit the application |
| 1 | Colour set 1 |
| 2 | Colour set 2 |
| 3 | Colour set 3 |
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/textual-mandelbrot",
"name": "textual-mandelbrot",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "davep@davep.org",
"keywords": "terminal,library,mandelbrot,maths",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "https://files.pythonhosted.org/packages/d7/56/434144c3bc2f2ecd7d16955a3df706caf85dd8f3632e6574164e43ac89fc/textual-mandelbrot-0.8.0.tar.gz",
"platform": null,
"description": "# textual-mandelbrot\n\n\n\n\n## Introduction\n\nThis package provides a simple Mandelbrot set widget that can be used in\n[Textual](https://textual.textualize.io/) applications, and also provides an\napplication that can be used to explore the classic Mandelbrot set in the\nterminal.\n\n## Installing\n\n### pipx\n\nThe package can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install textual-mandelbrot\n```\n\n### Homebrew\n\nThe package is available via Homebrew. Use the following commands to install:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install textual-mandelbrot\n```\n\n## Running\n\nOnce installed you should be able to run the command `mandelexp` and the\napplication will run.\n\n\n\n\n## Exploring\n\nIf you use `mandelexp` to run up the display, the following keys are\navailable:\n\n| Keys | Action |\n|-------------------|---------------------------------------|\n| Up, w, k | Move up |\n| Shift+Up, W, K | Move up slowly |\n| Down, s, j | Move down |\n| Shift+Down, S, J | Move down slowly |\n| Left, a, h | Move left |\n| Shift+Left, A, H | Move left slowly |\n| Right, d, l | Move right |\n| Shift+Right, D, L | Move right slowly |\n| PageUp, ] | Zoom in |\n| PageDown, [ | Zoom out |\n| Ctrl+PageUp, } | Zoon in deeper |\n| Ctrl+PageDown, { | Zoom out wider |\n| *, Ctrl+Up | Increase \"multobrot\" |\n| /, Ctrl+Down | Decrease \"multibrot\" |\n| Ctrl+Shift+Up | Increase \"multibrot\" in smaller steps |\n| Ctrl+Shift+Down | Decrease \"multibrot\" in smaller steps |\n| Home | Center 0,0 in the display |\n| , | Decrease iterations by 10 |\n| < | Decrease iterations by 100 |\n| . | Increase iterations by 10 |\n| > | Increase iterations by 100 |\n| Ctrl+r | Reset to initial state |\n| Escape | Quit the application |\n| 1 | Colour set 1 |\n| 2 | Colour set 2 |\n| 3 | Colour set 3 |\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: MIT License",
"summary": "A simple Mandelbrot explorer for the terminal.",
"version": "0.8.0",
"project_urls": {
"Discussions": "https://github.com/davep/textual-mandelbrot/discussions",
"Documentation": "https://github.com/davep/textual-mandelbrot/blob/main/README.md",
"Homepage": "https://github.com/davep/textual-mandelbrot",
"Issues": "https://github.com/davep/textual-mandelbrot/issues",
"Source": "https://github.com/davep/textual-mandelbrot"
},
"split_keywords": [
"terminal",
"library",
"mandelbrot",
"maths"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c994008570c6a3acd5acdd9ee31dc15825908e4e44e685280ed4f5eb5bf1479",
"md5": "cc961bb6fdcc0deb4f96a7d6b5a32197",
"sha256": "bd3406b153592084cd14166e68a3f9428c7799fc0c07e9a846b3e1b7dbe18179"
},
"downloads": -1,
"filename": "textual_mandelbrot-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc961bb6fdcc0deb4f96a7d6b5a32197",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10245,
"upload_time": "2024-03-10T12:11:47",
"upload_time_iso_8601": "2024-03-10T12:11:47.483456Z",
"url": "https://files.pythonhosted.org/packages/6c/99/4008570c6a3acd5acdd9ee31dc15825908e4e44e685280ed4f5eb5bf1479/textual_mandelbrot-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d756434144c3bc2f2ecd7d16955a3df706caf85dd8f3632e6574164e43ac89fc",
"md5": "8cc63b7bdd5d3b21b681ecf98f3a645b",
"sha256": "93d31cc7810176c292022c1b77aaa9e3481831cc1b5659303fc69e4a3e6e0b1f"
},
"downloads": -1,
"filename": "textual-mandelbrot-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "8cc63b7bdd5d3b21b681ecf98f3a645b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9990,
"upload_time": "2024-03-10T12:11:49",
"upload_time_iso_8601": "2024-03-10T12:11:49.166621Z",
"url": "https://files.pythonhosted.org/packages/d7/56/434144c3bc2f2ecd7d16955a3df706caf85dd8f3632e6574164e43ac89fc/textual-mandelbrot-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-10 12:11:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "textual-mandelbrot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "textual-mandelbrot"
}
JSON
