toga-code-editor 0.1.1__py3-none-any.whl

toga_code_editor-0.1.1.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: toga-code-editor
+Version: 0.1.1
+Summary: A Toga widget for editing code, with line numbers and syntax highlighting.
+Author-email: Kattni <hello@kattni.com>
+Maintainer-email: BeeWare Team <team@beeware.org>
+License-Expression: BSD-3-Clause
+Keywords: gui,widget,toga,code,editor,syntax-highlighting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Software Development :: Widget Sets
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: toga-core>=0.5.7
+Requires-Dist: pygments>=2.19
+Dynamic: license-file
+
+# toga-code-editor
+
+A [Toga](https://toga.beeware.org) widget for editing code, with line numbers and syntax highlighting. `CodeEditor` is a `toga.MultilineTextInput` that colors its text with [Pygments](https://pygments.org) and shows a line-number gutter. It supports macOS, iOS, and Android.
+
+## Installation
+
+```console
+pip install toga-code-editor
+```
+
+The package depends on `toga-core` and `pygments`. Your app installs the Toga backend for its platform as usual; `toga-code-editor` contributes its implementation for that backend through entry points, the same way Toga's own widgets are found.
+
+## Usage
+
+```python
+import toga
+from toga_code_editor import CodeEditor, language_for_filename
+
+editor = CodeEditor(
+    value=source,
+    language="python",  # any Pygments lexer alias; None turns highlighting off
+    show_line_numbers=True,
+    on_change=handle_edit,
+    flex=1,
+)
+
+# Pick the language from a file name. Unknown files get None, which means no highlighting.
+editor.language = language_for_filename(path)
+```
+
+`CodeEditor` inherits everything from `toga.MultilineTextInput`, including `value`, `readonly`, `placeholder`, `on_change`, `scroll_to_top`, and `scroll_to_bottom`. It adds three properties:
+
+- `language`: a Pygments lexer alias such as `"python"`, `"rust"`, or `"json"`. Setting an unknown alias raises `ValueError`. `None` disables highlighting. The default is `None`.
+- `show_line_numbers`: shows or hides the gutter. Default `True`.
+- `theme`: a mapping from `TokenKind` to `Style`. `None` selects the built-in `DEFAULT_THEME`.
+
+Unless you give the widget a font family, it uses a monospace font. Autocorrect, smart quotes, smart dashes, auto-capitalization, and spell checking are always off.
+
+### Themes
+
+A theme is a plain mapping. Kinds you leave out are drawn in the widget's normal text color.
+
+```python
+from toga_code_editor import DEFAULT_THEME, Style, TokenKind
+
+theme = {
+    **DEFAULT_THEME,
+    TokenKind.COMMENT: Style("#6a737d", italic=True),
+    TokenKind.KEYWORD: Style("rebeccapurple", bold=True),
+}
+editor.theme = theme
+```
+
+`Style.color` accepts anything Toga's color properties accept. The token kinds are `KEYWORD`, `BUILTIN`, `DEFINITION`, `DECORATOR`, `STRING`, `NUMBER`, `COMMENT`, `OPERATOR`, `PUNCTUATION`, `TAG`, `ATTRIBUTE`, and `VARIABLE`.
+
+## Platform notes
+
+- **macOS** uses an `NSRulerView` for the gutter and the system's adaptive color mapping, so theme colors follow dark mode.
+- **iOS** and **Android** draw the gutter themselves. Theme colors do not change with the system appearance; the default theme is chosen to be legible on both light and dark backgrounds.
+- Highlighting re-lexes the whole buffer after a short pause in typing. Files of a few thousand lines are fine on a desktop; very large files are slower on phones.
+- Some third-party Android keyboards ignore the flag that disables suggestions.
+- On Android, the widget asks the window to shrink its content when the soft keyboard appears, so the editor scrolls internally and the rest of the layout stays put. It only does this when the app has not chosen a soft-input mode itself.
+
+## Developing
+
+```console
+uv venv
+uv pip install -e . --group dev
+.venv/bin/tox -m test
+```
+
+The test suite runs against Toga's dummy backend. Real backends are checked with the example app in `examples/editor`:
+
+```console
+cd examples/editor
+briefcase dev            # macOS
+briefcase run iOS
+briefcase run android
+```
+
+On macOS and iOS the example installs the widget straight from this repository; add `-r` after changing the widget source so Briefcase reinstalls it. On Android the example installs the widget from a wheel in `dist/`, because Gradle rejects a path requirement whose directory contains the Android build tree. Build the wheel before each Android run that should pick up widget changes:
+
+```console
+uv build --wheel
+cd examples/editor
+briefcase run android -r
+```
+
+Every user-visible change needs a fragment in `changes/`, named `<issue>.<kind>.md` where kind is `feature`, `bugfix`, `doc`, or `misc`. Release notes are assembled with `towncrier build`.
+
+## Community
+
+`toga-code-editor` is part of the [BeeWare suite](http://beeware.org). You can talk to the community through:
+
+- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware)
+- [Discord](https://beeware.org/bee/chat/)
+
+We foster a welcoming and respectful community as described in our [BeeWare Community Code of Conduct](http://beeware.org/community/behavior/).
+
+## Contributing
+
+If you experience problems with the `CodeEditor` widget, [log them on GitHub](https://github.com/beeware/toga-code-editor/issues). If you want to contribute code, please [fork the code](https://github.com/beeware/toga-code-editor) and [submit a pull request](https://github.com/beeware/toga-code-editor/pulls).

toga_code_editor-0.1.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+toga_code_editor/__init__.py,sha256=4O8bQ_gVrrVYHyI3QZZQwtpxOVc1qkF_6yJebnH-KbY,350
+toga_code_editor/code_editor.py,sha256=KGdpFRqn6zukBh3_2NRdLdRiTt7pbp1NSpN4FNI1Of8,6133
+toga_code_editor/highlighting.py,sha256=C0C9Eyy6Bu5ZXU4IW3zNZk0Gbi0i-4vWFMFyoXIWiuI,6106
+toga_code_editor/platforms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toga_code_editor/platforms/android.py,sha256=aWx63Lj4HlGNLqDbI3fo2tVzUwelxTmRYyGj9b_9XIk,8676
+toga_code_editor/platforms/cocoa.py,sha256=FtQotsX0XZM7YDx1jupg5KKfrd-XjhWwkWKABacq4e0,9866
+toga_code_editor/platforms/dummy.py,sha256=1vtlDM1HO4a1Jm2WyOCzP1YfypSBZ-SYpCoD48hxKK4,648
+toga_code_editor/platforms/iOS.py,sha256=s5Pb4CReK-bdabg4Q2oOUZ5Ie6th_osIkGUuBzGiYK4,11792
+toga_code_editor-0.1.1.dist-info/licenses/LICENSE,sha256=LZFBFf-4Wc8AA73Jms6mPJOZxzRk6_bA-u92jQ-CDME,1501
+toga_code_editor-0.1.1.dist-info/METADATA,sha256=PJPlhLy1s3MHZ0-0nH9g4Ty5EbN32Fj2l7uw-yIJLV4,5867
+toga_code_editor-0.1.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+toga_code_editor-0.1.1.dist-info/entry_points.txt,sha256=L-uapfZ1foowkY7_r3BuWOisd96g7Om3PD58TPsHnYg,383
+toga_code_editor-0.1.1.dist-info/top_level.txt,sha256=NaP31teLbDeXb1cu667SvBDKw890Iyeu2uY4hWuoDoE,17
+toga_code_editor-0.1.1.dist-info/RECORD,,

toga_code_editor-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

toga_code_editor-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,11 @@
+[toga_code_editor.backend.toga_android]
+CodeEditor = toga_code_editor.platforms.android:CodeEditor
+
+[toga_code_editor.backend.toga_cocoa]
+CodeEditor = toga_code_editor.platforms.cocoa:CodeEditor
+
+[toga_code_editor.backend.toga_dummy]
+CodeEditor = toga_code_editor.platforms.dummy:CodeEditor
+
+[toga_code_editor.backend.toga_iOS]
+CodeEditor = toga_code_editor.platforms.iOS:CodeEditor

toga_code_editor-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2026, Russell Keith-Magee
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of toga-code-editor nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

toga_code_editor-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+toga_code_editor