pyinkcli 0.1.0__tar.gz

pyinkcli-0.1.0/.gitignore

@@ -0,0 +1,154 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

pyinkcli-0.1.0/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) Vadym Demedes <vadimdemedes@hey.com> (https://github.com/vadimdemedes)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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.

pyinkcli-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: pyinkcli
+Version: 0.1.0
+Summary: Python fork and translation of Ink for building terminal UIs
+Project-URL: Homepage, https://github.com/quantmew/pyinkcli
+Project-URL: Documentation, https://github.com/quantmew/pyinkcli#readme
+Project-URL: Repository, https://github.com/quantmew/pyinkcli
+Project-URL: Issues, https://github.com/quantmew/pyinkcli/issues
+Author: Quantmew Contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,component,console,ink,react,terminal,ui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: Python Modules
+Classifier: Topic :: Terminals
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: colorama>=0.4.0
+Requires-Dist: wcwidth>=0.2.0
+Requires-Dist: yoga-layout-python>=0.1.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyinkcli
+
+<div align="center">
+	<br>
+	<img width="220" alt="pyinkcli" src="media/logo.png">
+	<br>
+	<br>
+</div>
+
+> A Python fork and translation project of [Ink](https://github.com/vadimdemedes/ink) for building terminal UIs with a React-like component model.
+
+`pyinkcli` is a Python implementation inspired by and translated from Ink. This repository is a fork, not the official Node.js package, and the API is adapted for Python where needed.
+
+<div align="center">
+	<img src="media/demo.svg" width="640" alt="Ink demo">
+</div>
+
+## Install
+
+```bash
+pip install pyinkcli
+```
+
+## Quick Start
+
+```python
+from pyinkcli import Box, Text, render
+
+
+def Counter():
+    return Box(
+        Text("Hello from pyinkcli", color="green", bold=True),
+        flexDirection="column",
+        alignItems="center",
+    )
+
+
+app = render(Counter)
+app.wait_until_exit()
+```
+
+## What This Repo Is
+
+- A Python fork of Ink focused on translating the terminal UI model into Python
+- A repo that keeps the upstream JS implementation nearby for parity work and audits
+- A place for Python-native examples and tests under `examples/` and `tests/`
+
+## Examples
+
+- `examples/alternate-screen/`
+- `examples/chat/`
+- `examples/counter/`
+- `examples/terminal-resize/`
+- `examples/use-focus/`
+- `examples/use-input/`
+
+## License
+
+MIT. The repository includes the upstream Ink license text in [`LICENSE`](LICENSE).

pyinkcli-0.1.0/README.md

@@ -0,0 +1,59 @@
+# pyinkcli
+
+<div align="center">
+	<br>
+	<img width="220" alt="pyinkcli" src="media/logo.png">
+	<br>
+	<br>
+</div>
+
+> A Python fork and translation project of [Ink](https://github.com/vadimdemedes/ink) for building terminal UIs with a React-like component model.
+
+`pyinkcli` is a Python implementation inspired by and translated from Ink. This repository is a fork, not the official Node.js package, and the API is adapted for Python where needed.
+
+<div align="center">
+	<img src="media/demo.svg" width="640" alt="Ink demo">
+</div>
+
+## Install
+
+```bash
+pip install pyinkcli
+```
+
+## Quick Start
+
+```python
+from pyinkcli import Box, Text, render
+
+
+def Counter():
+    return Box(
+        Text("Hello from pyinkcli", color="green", bold=True),
+        flexDirection="column",
+        alignItems="center",
+    )
+
+
+app = render(Counter)
+app.wait_until_exit()
+```
+
+## What This Repo Is
+
+- A Python fork of Ink focused on translating the terminal UI model into Python
+- A repo that keeps the upstream JS implementation nearby for parity work and audits
+- A place for Python-native examples and tests under `examples/` and `tests/`
+
+## Examples
+
+- `examples/alternate-screen/`
+- `examples/chat/`
+- `examples/counter/`
+- `examples/terminal-resize/`
+- `examples/use-focus/`
+- `examples/use-input/`
+
+## License
+
+MIT. The repository includes the upstream Ink license text in [`LICENSE`](LICENSE).

pyinkcli-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyinkcli"
+dynamic = ["version"]
+description = "Python fork and translation of Ink for building terminal UIs"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "Quantmew Contributors" }
+]
+keywords = [
+    "cli",
+    "console",
+    "terminal",
+    "ui",
+    "react",
+    "ink",
+    "component",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Terminals",
+    "Typing :: Typed",
+]
+dependencies = [
+    "wcwidth>=0.2.0",
+    "colorama>=0.4.0",
+    "yoga-layout-python>=0.1.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/quantmew/pyinkcli"
+Documentation = "https://github.com/quantmew/pyinkcli#readme"
+Repository = "https://github.com/quantmew/pyinkcli"
+Issues = "https://github.com/quantmew/pyinkcli/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyinkcli"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src/pyinkcli",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.version]
+path = "src/pyinkcli/__init__.py"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "B", "C4", "SIM"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

pyinkcli-0.1.0/src/pyinkcli/__init__.py

@@ -0,0 +1,59 @@
+"""pyinkcli public package surface."""
+
+from pyinkcli.index import (
+    DOMElement,
+    Box,
+    Key,
+    Newline,
+    Spacer,
+    Static,
+    Text,
+    Transform,
+    kittyFlags,
+    kittyModifiers,
+    measureElement,
+    render,
+    renderToString,
+    useApp,
+    useBoxMetrics,
+    useCursor,
+    useFocus,
+    useFocusManager,
+    useInput,
+    useIsScreenReaderEnabled,
+    usePaste,
+    useStderr,
+    useStdin,
+    useStdout,
+    useWindowSize,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "render",
+    "renderToString",
+    "Box",
+    "Text",
+    "Static",
+    "Transform",
+    "Newline",
+    "Spacer",
+    "Key",
+    "useInput",
+    "usePaste",
+    "useApp",
+    "useStdin",
+    "useStdout",
+    "useStderr",
+    "useFocus",
+    "useFocusManager",
+    "useIsScreenReaderEnabled",
+    "useCursor",
+    "useWindowSize",
+    "useBoxMetrics",
+    "measureElement",
+    "DOMElement",
+    "kittyFlags",
+    "kittyModifiers",
+]