unicode-animatio 0.0.1__py3-none-any.whl

unicode_animatio-0.0.1.dist-info/METADATA

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: unicode-animatio
+Version: 0.0.1
+Summary: Unicode spinner animations as raw frame data for Python
+Project-URL: Homepage, https://github.com/openminion/unicode-animatio
+Project-URL: Repository, https://github.com/openminion/unicode-animatio
+Project-URL: Documentation, https://github.com/openminion/unicode-animatio/tree/main/docs
+Project-URL: Issues, https://github.com/openminion/unicode-animatio/issues
+Author: unicode-animatio contributors
+License: MIT
+License-File: LICENSE
+Keywords: animation,braille,cli,loading,spinner,terminal,unicode
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Terminals
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == 'dev'
+Requires-Dist: pre-commit<5,>=4; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://www.openminion.com/brand/openminion-logo.png" alt="OpenMinion logo" width="128" />
+</p>
+
+<h1 align="center">unicode-animatio</h1>
+
+<p align="center">
+  <strong>Lightweight Unicode braille spinner animations for Python.</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/openminion/unicode-animatio">GitHub</a>
+  · <a href="#install">Install</a>
+  · <a href="#what-the-package-provides">What Ships</a>
+  · <a href="https://www.openminion.com">Website</a>
+  · <a href="https://x.com/OpenMinion">X</a>
+</p>
+
+<p align="center">
+  <img alt="Package version" src="https://img.shields.io/badge/package-0.0.1-3775A9">
+  <img alt="Python" src="https://img.shields.io/badge/python-3.9%2B-3775A9">
+  <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue"></a>
+  <img alt="Status" src="https://img.shields.io/badge/status-beta-5B8DEF">
+</p>
+
+- 18 spinner families as raw frame data
+- typed Python API with JS-style compatibility aliases
+- built-in terminal preview CLI and local browser demo
+- no runtime dependencies
+
+`unicode-animatio` is the public package and repo name. The Python import root
+remains `unicode_animations`, while the public CLI entrypoints use
+`unicode-animatio` and `unicode-animatio-web`.
+
+## Official project links
+
+- GitHub: `https://github.com/openminion/unicode-animatio`
+- Issues: `https://github.com/openminion/unicode-animatio/issues`
+
+## What the package provides
+
+`unicode-animatio` provides:
+
+- immutable spinner frame data via `unicode_animations.spinners`
+- braille-grid helpers: `make_grid` and `grid_to_braille`
+- compatibility aliases: `makeGrid` and `gridToBraille`
+- a terminal preview CLI: `unicode-animatio`
+- a local web preview CLI: `unicode-animatio-web`
+
+## What the package does not provide
+
+This package does not provide:
+
+- async terminal rendering frameworks
+- progress bars, task orchestration, or job-state tracking
+- hosted demo infrastructure or remote APIs
+- framework-specific adapters for Rich, Textual, or Typer
+
+## Install
+
+Install from PyPI:
+
+```bash
+python3 -m pip install unicode-animatio
+```
+
+Editable install during local development:
+
+```bash
+python3 -m pip install -e ".[dev]"
+```
+
+## Quick start
+
+```python
+from unicode_animations import spinners
+
+spinner = spinners["braille"]
+print(spinner.frames)
+print(spinner.interval)
+```
+
+Grid helpers:
+
+```python
+from unicode_animations import grid_to_braille, make_grid
+
+grid = make_grid(4, 4)
+grid[0][0] = True
+grid[1][1] = True
+grid[2][2] = True
+grid[3][3] = True
+
+print(grid_to_braille(grid))
+```
+
+## CLI and demos
+
+Terminal preview:
+
+```bash
+unicode-animatio --list
+unicode-animatio
+unicode-animatio helix
+```
+
+Local browser demo:
+
+```bash
+unicode-animatio --web
+unicode-animatio-web --port 8765
+unicode-animatio-web --host 0.0.0.0 --port 8765 --no-open
+```
+
+Python API terminal demo:
+
+```bash
+python examples/terminal_demo.py
+python examples/terminal_demo.py --seconds-per-spinner 2 --loops 2
+python examples/terminal_demo.py helix
+python examples/terminal_demo.py --list
+```
+
+## Available animations
+
+The package currently ships these braille spinner families. The preview glyph is
+the first frame from each animation:
+
+| Name | Preview | Frames | Interval |
+| --- | --- | ---: | ---: |
+| `braille` | `⠋` | 10 | 80ms |
+| `braillewave` | `⠁⠂⠄⡀` | 8 | 100ms |
+| `dna` | `⠋⠉⠙⠚` | 12 | 80ms |
+| `scan` | `⠀⠀⠀⠀` | 10 | 70ms |
+| `rain` | `⢁⠂⠔⠈` | 12 | 100ms |
+| `scanline` | `⠉⠉⠉` | 6 | 120ms |
+| `pulse` | `⠀⠶⠀` | 5 | 180ms |
+| `snake` | `⣁⡀` | 16 | 80ms |
+| `sparkle` | `⡡⠊⢔⠡` | 6 | 150ms |
+| `cascade` | `⠀⠀⠀⠀` | 14 | 60ms |
+| `columns` | `⡀⠀⠀` | 26 | 60ms |
+| `orbit` | `⠃` | 8 | 100ms |
+| `breathe` | `⠀` | 17 | 100ms |
+| `waverows` | `⠖⠉⠉⠑` | 16 | 90ms |
+| `checkerboard` | `⢕⢕⢕` | 4 | 250ms |
+| `helix` | `⢌⣉⢎⣉` | 16 | 80ms |
+| `fillsweep` | `⣀⣀` | 11 | 100ms |
+| `diagswipe` | `⠁⠀` | 16 | 60ms |
+
+For a live preview:
+
+```bash
+unicode-animatio --list
+unicode-animatio helix
+unicode-animatio --web
+```
+
+## Development
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+python3 -m pip install -e ".[dev]"
+python3 -m pytest -q
+python3 -m ruff check .
+python3 -m build
+```
+
+## Package docs
+
+- [Getting started](docs/getting-started.md)
+- [Package docs index](docs/README.md)
+- [API compatibility](API_COMPATIBILITY.md)
+- [Release guide](RELEASING.md)
+- [Source tree owner map](docs/source-tree-owner-map.md)
+
+## Trust and Brand Safety
+
+- Official GitHub: `https://github.com/openminion/unicode-animatio`
+- Official website: `https://www.openminion.com`
+- Official X account: `https://x.com/OpenMinion`
+
+`unicode-animatio` has no official token, coin, NFT, airdrop, staking
+program, treasury product, or investment offering. Any claim otherwise is
+unauthorized and should be treated as a scam.
+
+## License and brand-use boundary
+
+- Source code license: `MIT`
+- Brand/trademark grant: `none`
+
+The software license grants rights to use, modify, and redistribute the code.
+It does **not** grant rights to use the unicode-animatio or OpenMinion
+names, logos, branding, website identity, or social identity except for
+truthful attribution. Forks, clones, and derivative distributions must not
+present themselves as the official unicode-animatio package or imply
+affiliation, endorsement, or maintenance by unicode-animatio or OpenMinion
+contributors unless that is actually true.
+
+## Community
+
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [License (MIT)](LICENSE)

unicode_animatio-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+unicode_animations/__init__.py,sha256=VLoKowbEwv_l7p_0IWPyCI9mYlCfxf_szTstrxk3dFg,536
+unicode_animations/__main__.py,sha256=o8kW7cWSR6EtXZUqC1f4Ye040u9P4vyk1UbKuB5gUkA,108
+unicode_animations/braille.py,sha256=YhAQWbynkIRXwkDtmndYf0cT9Uzfh1s9PKlk8kkDAvc,15896
+unicode_animations/cli.py,sha256=FvhKGxatSGA7KaESEb0n4-71U5cZb_xKD9fNBHypsr8,3084
+unicode_animations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unicode_animations/web.py,sha256=b7EYVOiwoZiV3tSCkZOsYS1QXyon-6Gr35L6SD_v3_4,9292
+unicode_animatio-0.0.1.dist-info/METADATA,sha256=chIjuBdZbC7bekiGfIQQFXbQ9qtmW_EW8RHHOwfx348,6986
+unicode_animatio-0.0.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+unicode_animatio-0.0.1.dist-info/entry_points.txt,sha256=NL_9AC9PEELJlD4UmDk2v3gLj8V3503M-3MTVI5WkY0,116
+unicode_animatio-0.0.1.dist-info/licenses/LICENSE,sha256=sG4u-94gFxSsUAQtVehvrdLr1Hk_ptnoZskC7yFLaXY,1086
+unicode_animatio-0.0.1.dist-info/RECORD,,

unicode_animatio-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

unicode_animatio-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+unicode-animatio = unicode_animations.cli:main
+unicode-animatio-web = unicode_animations.web:main

unicode_animatio-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 unicode-animatio contributors
+
+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.

unicode_animations/__init__.py

@@ -0,0 +1,28 @@
+"""Unicode braille spinner animations for Python."""
+
+__version__ = "0.0.1"
+
+from .braille import (
+    BRAILLE_SPINNER_NAMES,
+    BrailleSpinnerName,
+    Spinner,
+    grid_to_braille,
+    make_grid,
+    spinners,
+)
+
+# Compatibility aliases mirroring the original JavaScript API style.
+gridToBraille = grid_to_braille
+makeGrid = make_grid
+
+__all__ = [
+    "__version__",
+    "Spinner",
+    "BrailleSpinnerName",
+    "BRAILLE_SPINNER_NAMES",
+    "spinners",
+    "grid_to_braille",
+    "make_grid",
+    "gridToBraille",
+    "makeGrid",
+]

unicode_animations/__main__.py

@@ -0,0 +1,5 @@
+"""Command entrypoint for python -m unicode_animations."""
+
+from .cli import main
+
+raise SystemExit(main())