textual-searchable-selectionlist 0.0.1__tar.gz

textual_searchable_selectionlist-0.0.1/.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[Makefile]
+indent_style = tab

textual_searchable_selectionlist-0.0.1/.gitignore

@@ -0,0 +1,73 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# DS Store files
+.DS_Store
+
+# IDE settings
+.vscode/
+.idea/
+
+# Misc
+release-notes.md

textual_searchable_selectionlist-0.0.1/LICENSE.txt

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

textual_searchable_selectionlist-0.0.1/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: textual-searchable-selectionlist
+Version: 0.0.1
+Summary: Add search to Textual SelectionList.
+Author: Joao Coelho
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Development Status :: 4 - Beta
+License-File: LICENSE.txt
+Requires-Dist: textual
+Project-URL: Home, https://github.com/joaonc/textual-searchable-selectionlist
+
+# Searchable SelectionList
+Add search to Textual's [SelectionList](https://textual.textualize.io/widgets/selection_list/).
+
+* Selectable items can be filtered by substring.
+* Select one or multiple items.
+* Search is case-insensitive.
+
+## Installation
+```bash
+pip install searchable-selection-list
+```
+
+## Usage
+```python
+from textual_searchable_selectionlist.options import SelectionStrategy
+from textual_searchable_selectionlist.select import select, select_enum
+
+selected = select(
+    ['John', 'Jane', 'James'],
+    selection_strategy=SelectionStrategy.MULTIPLE,
+    search_title='Select people',
+)
+
+# Enums
+# class Color(Enum):
+#     RED = 'red'
+#     GREEN = 'green'
+#
+# selected_colors = select_enum(Color, selection_strategy=SelectionStrategy.ONE)
+```
+
+## Testing
+There are currently no automated tests. Manual testing can be done by running:
+```bash
+python tests/manual/searchable_selection_list_select.py
+```
+

textual_searchable_selectionlist-0.0.1/README.md

@@ -0,0 +1,36 @@
+# Searchable SelectionList
+Add search to Textual's [SelectionList](https://textual.textualize.io/widgets/selection_list/).
+
+* Selectable items can be filtered by substring.
+* Select one or multiple items.
+* Search is case-insensitive.
+
+## Installation
+```bash
+pip install searchable-selection-list
+```
+
+## Usage
+```python
+from textual_searchable_selectionlist.options import SelectionStrategy
+from textual_searchable_selectionlist.select import select, select_enum
+
+selected = select(
+    ['John', 'Jane', 'James'],
+    selection_strategy=SelectionStrategy.MULTIPLE,
+    search_title='Select people',
+)
+
+# Enums
+# class Color(Enum):
+#     RED = 'red'
+#     GREEN = 'green'
+#
+# selected_colors = select_enum(Color, selection_strategy=SelectionStrategy.ONE)
+```
+
+## Testing
+There are currently no automated tests. Manual testing can be done by running:
+```bash
+python tests/manual/searchable_selection_list_select.py
+```

textual_searchable_selectionlist-0.0.1/WARP.md

@@ -0,0 +1,143 @@
+# WARP.md
+
+This file provides guidance to WARP (warp.dev) when working with code in this repository.
+
+## Project Overview
+
+A Textual widget library that adds search functionality to Textual's SelectionList widget. The widget provides case-insensitive substring filtering, supports single and multiple selection modes, and offers an API for programmatic selection in terminal-based applications.
+
+## Development Commands
+
+### Task Runner
+This project uses `typer-invoke` to organize development tasks into admin modules. The configuration is in `pyproject.toml` under `[tool.typer-invoke]`.
+
+Run tasks using Python module syntax:
+```bash
+python -m admin.lint --help
+python -m admin.build --help
+python -m admin.pip --help
+```
+
+### Linting and Formatting
+All linter configurations are in `pyproject.toml`.
+
+Run all linters in sequence:
+```bash
+python -m admin.lint all
+```
+
+Run individual linters:
+```bash
+python -m admin.lint black .
+python -m admin.lint isort .
+python -m admin.lint flake8 .
+python -m admin.lint mypy .
+```
+
+### Building and Publishing
+
+Clean build artifacts:
+```bash
+python -m admin.build clean
+```
+
+Update version (interactive or with flags):
+```bash
+python -m admin.build version --bump patch
+python -m admin.build version --version 1.2.3
+```
+
+Build and publish package:
+```bash
+python -m admin.build publish
+```
+
+### Package Management
+
+Compile requirements files (uses pip-compile):
+```bash
+python -m admin.pip compile
+python -m admin.pip compile --clean
+```
+
+Sync environment with requirements:
+```bash
+python -m admin.pip sync
+```
+
+Install requirements:
+```bash
+python -m admin.pip install
+```
+
+### Testing
+
+There are currently no automated unit tests. Manual testing can be done by running:
+```bash
+python tests/manual/searchable_selection_list_select.py
+```
+
+## Code Architecture
+
+### Core Components
+
+**SearchableListWidget** (`searchable_list_widget.py`)
+- Main widget that combines a search Input with a SelectionList
+- Handles keyboard navigation (arrow keys, enter, escape, ctrl+space/a/d)
+- Implements real-time filtering by disabling non-matching options
+- Generic over SelectionType for type safety
+- Key behavior: when focused on SelectionList, alphanumeric keys are routed to the search input
+
+**SearchableListApp** (`searchable_list_app.py`)
+- Textual App wrapper for SearchableListWidget
+- Provides full-screen or inline display modes
+- Returns selected items via app.exit()
+- Handles SelectionStrategy.ALL by immediately exiting with all items
+
+**SelectionStrategy** (`options.py`)
+- Enum defining selection modes: MULTIPLE, ONE, ALL, FAIL
+- MULTIPLE/ALL: Allow selecting multiple items
+- ONE: Single selection mode (deselects others when selecting)
+- FAIL: Raises ValueError if multiple selections provided
+
+**select() function** (`select.py`)
+- High-level API for quick item selection
+- Returns list of selected items
+- Supports string, tuple, or Selection objects as input
+- Includes select_enum() helper for selecting from Python enums
+
+### Module Structure
+```
+src/textual_searchable_selectionlist/
+├── __init__.py              # Version info
+├── searchable_list_widget.py # Core widget implementation
+├── searchable_list_app.py    # Textual app wrapper
+├── options.py                # Selection mode enum and filtering options
+└── select.py                 # High-level selection API
+
+admin/                        # Development task modules
+├── __init__.py              # Project constants (PROJECT_ROOT, SOURCE_DIR)
+├── utils.py                 # Shared utilities (run, logger, etc.)
+├── build.py                 # Build, version, and publish tasks
+├── lint.py                  # Linting tasks
+├── pip.py                   # Package management tasks
+└── requirements/            # Requirements files (.in and .txt)
+```
+
+### Key Design Patterns
+
+**Filtering mechanism**: Items are filtered by setting `option.disabled = not is_match` rather than removing them from the list, preserving indices.
+
+**Keyboard routing**: When SelectionList is focused, single alphanumeric keypresses are intercepted and forwarded to the search Input via `input_widget.post_message(event)`.
+
+**Callback-based selection**: Widget accepts `selected_callback` that's invoked on Enter key, receiving the list of selected items.
+
+**Build system**: Uses flit for building/publishing. Version is tracked in both `pyproject.toml` and `src/textual_searchable_selectionlist/__init__.py`.
+
+## Code Style
+
+- Follow PEP8 with 100 character line limit (enforced by black)
+- Single quotes for strings, triple double quotes for docstrings
+- Python 3.12+ syntax and type hints (use `str | None` not `Optional[str]`)
+- 4 spaces for indentation
+- Line endings: LF (Unix style, see `.editorconfig`)

textual_searchable_selectionlist-0.0.1/admin/__init__.py

@@ -0,0 +1,5 @@
+from pathlib import Path
+
+PROJECT_ROOT = Path(__file__).parents[1]
+PROJECT_NAME = PROJECT_ROOT.name.replace('-', '_')
+SOURCE_DIR = PROJECT_ROOT / 'src' / PROJECT_NAME