listpick 0.1.4.0__py3-none-any.whl

listpick-0.1.4.0.dist-info/METADATA

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: listpick
+Version: 0.1.4.0
+Summary: List Picker is a powerful TUI data tool for creating TUI apps or viewing/comparing tabulated data.
+Home-page: https://github.com/grimandgreedy/list_picker
+Author: Grim
+Author-email: grimandgreedy@protonmail.com
+Project-URL: Bug Tracker, https://github.com/grimandgreedy/list_picker/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+Requires-Dist: setuptools
+Requires-Dist: dill
+Requires-Dist: wcwidth
+Requires-Dist: ipython
+Requires-Dist: msgpack
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: pyperclip
+Requires-Dist: toml
+Requires-Dist: traitlets
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# list_picker
+
+List Picker is a TUI tool which allows one to display and select from a list of rows. A very simple concept but also, I hope, a powerful tool that will make it easier for people to develop TUI apps.
+
+Rows of data can be viewed, selected, generated, saved, loaded, refreshed, modified or copied to the clipboard. Easy to integrate into your project by creating a `menu = Picker(stdscr, items:list[list[str]])` and then the menu will be displayed by running `menu.run()`.
+
+It works great as the backend for a TUI application and can also be used as a standalone data viewer.
+
+**NOTE**: list_picker is still in development.
+
+# Quickstart
+
+```
+git clone https://github.com/grimandgreedy/list_picker
+
+cd list_picker && python -m pip install -r requirements.txt
+
+python list_picker.py -g ./examples/list_files.py
+```
+
+## Overview
+
+The application allows you to:
+- Select multiple items from different file types and input streams
+- Delete individual items
+- Highlight specific items for quick selection
+- Filtering: supports regular expressions for row- and column-based filtering.
+- Searching: supports regular expressions for row- and column-based searching.
+- Sort data based on specified columns and sort-type
+- Save and load data.
+- Copy/paste selections to clipboard
+- Generate rows from a list of commands in an input.toml file.
+
+## Examples
+
+
+- Identify video duplicates (./examples/video_duplicates.toml):
+```python 
+python list_picker.py -g ./examples/video_duplicates.toml
+```
+  - From the list of commands in the toml file we generate the properties we will use to identify the duplicates. 
+
+  - In the example file we set the directory and get the files with a simle `eza` (`ls`) command. We could also use `find` or `cat` from a list of files.
+
+
+  - We get the SHA1 hash to identify identical files; we also get the size, duration, resolution, and bitrate so that we can identify a video duplicate that may have the same duration but a lower resolution.
+
+<div align="center"> <img src="assets/file_compare.png" alt="Video Compare" width="70%"> </div>
+
+
+  - [Aria2TUI](https://github.com/grimandgreedy/Aria2TUI) is implemented using list_picker. This is a good example of how list_picker can be used for menus, data viewing, and active data retrieval.
+
+<div align="center"> <img src="assets/aria2tui_screenshot.png" alt="Aria2TUI" width="70%"> </div>
+
+  - [lpfman](https://github.com/grimandgreedy/lpfman) is a basic file manager created for the purposes of illustrating how easy TUI apps can be developed with the use of list_picker. In 20 minutes and <100 lines of code we made a very basic file manager.
+
+<div align="center"> <img src="assets/lpfman.png" alt="lpfman" width="70%"> </div>
+
+
+
+## Description
+
+### Key Features:
+1. **File Input Support:**
+```python 
+python list_picker.py -i ~/dn.pkl -t pkl
+```
+   - Text files (TSV, CSV)
+   - JSON
+   - XLSX
+   - ODS (OpenDocument Spreadsheet)
+   - Pickle
+
+2. **Generate data based on an toml file with relevant commands to generate the rows.**
+```python 
+python list_picker.py -g ./examples/video_duplicates.toml
+```
+
+  - See ./examples/
+
+3. **Highlighting:**
+  - Highlight specific strings for display purposes.
+  - E.g., when we search for a string we will highlight strings in the rows that match the search.
+
+4. **Filtering and Sorting:**
+  - Apply custom filters and sort criteria on the fly
+
+5. **Modes:**
+  - Default modes are supported so that a certain filter/search/sort can structure the data in a way that is easy to move between.
+
+
+6. **Options:**
+  - Along with returning the selected rows, the user can also return options.
+  - Input field with readline support
+  - Options select box
+
+7. **Colour themes:**
+  - Several colour themes are available
+
+8. **Copy rows:**
+  - 'y' to copy rows in various formats: CSV, TSV, python list
+9. **Save data:**
+  - Data can be saved so that it can be loaded with the -i flag.
+  - This is very helpful if your data generation takes a long time.
+10. **Customisable keybinds:**
+   - The list_picker application takes a key dictionary so that certain functions can easily be changed to a preferred keybind.
+   - Also allows the restriction of certain functions by not assigning a key.
+11. **Dynamic or manual refresh of data**:
+   - If a refresh_function is passed with auto_refresh=True then list_picker will automatically refresh the data.
+    - If a refresh_function is passed then one can also manually refresh by pressing f5.
+12. Notifications.
+   - Supports notifications upon certain events
+13. Visual options
+   - Display/hide title. 
+   - Display/hide footer with selection information
+   - Display/hide columns
+   - Display/hide highlights
+   - Option to centre in cells, centre in terminal and centre rows vertically.
+
+14. Change settings on the fly.
+   - Press '~' to see list of display settings or press '`' to enter a command to change display settings.
+   - Change visual options
+       - Cycle through themes
+       - Centre data in cells or centre rows vertically
+       - Show/hide the footer
+       - Show/hide a specific column.
+       - Select a column
+   - Toggle auto-refresh
+   - Toggle highlights
+
+15. Pipe the data from the selected rows in the focussed column to a bash command ('|')
+   - By default when you press '|' it will fill the input field with `xargs -d '\n' -I {} `. You can remove this if you like (^U).
+   - If you add `notify-send {}` to this it will display notifications containing the data from the current column 
+   - Useful for:
+       - Opening files with a specific application `xargs -d \n -I{} mpv {}` will open the files in mpv
+       - Dumping data. `xargs -d \n -I{} echo {} > ~/stuff.txt`
+
+## Overview
+
+The application allows you to:
+- Select multiple items from different file types and input streams
+- Navigate between selected items with arrow keys
+- Delete individual items
+- Highlight specific items for quick selection
+- Perform complex filtering operations
+- Sort data based on specified columns
+- Persistent save/load of selections
+- Copy/paste selections to clipboard
+
+
+## Support and Feedback
+
+Feel free to request features. Please report any errors you encounter with appropriate context.

listpick-0.1.4.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+list_picker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+list_picker/list_picker_app.py,sha256=ekgg7dDsIS407Mo7_yZfJqhVpy4on-7Y_uV46n9aZWc,109661
+list_picker/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+list_picker/ui/help_screen.py,sha256=OJnTI8DI-H9UUTUjdKgvfj5dFXs866gfNESR2vpYkBs,5540
+list_picker/ui/input_field.py,sha256=VdVjXmbUOYXsJu4byCZuzjdQ5_hw7fwFuDl_cjjnFk8,7165
+list_picker/ui/keys.py,sha256=KzUZaYEA-axgL4Qf5jDZJDKXx6kKyaLezhiGFVu8aSg,12303
+list_picker/ui/list_picker_colours.py,sha256=hOy7KFgGtLm13dYXWRdX3iymxgKk9CzgGyyaNOkTDRI,7668
+list_picker/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+list_picker/utils/clipboard_operations.py,sha256=dlRVz3aOON6y7gjBy2eP5y3Tf7zVFalHpQ47GE219EI,1678
+list_picker/utils/dump.py,sha256=oSoT8rTCAPxF5Sl4AwWpGrUztNKUXwOowCudW0Pj0yw,3299
+list_picker/utils/filtering.py,sha256=ER2dHyFOgABE-aXbl7MbNM4fDWZe9dqkyexGBuWICHU,938
+list_picker/utils/generate_data.py,sha256=TBeSLhB6O-UD0mQUMQSSUESoWOHYDXcX99ahbyUwfOo,2497
+list_picker/utils/options_selectors.py,sha256=cFWz-7i4UzsTaelh6RyPv90-joeDw8TZqcDX0GdjXR8,2299
+list_picker/utils/search_and_filter_utils.py,sha256=WUykgedUr9ZsRzCbS_u4bDOqvUwnx0bG7dgC3LSUATQ,2778
+list_picker/utils/searching.py,sha256=dy-RWVOs1fFV6do0-G3k3unE6mtyyoUGEyJWZvudxRs,2809
+list_picker/utils/sorting.py,sha256=4VmwExgXbDwc7Oe6jdsWbyGuXzFOG3QbmOvsVXHWmPs,4951
+list_picker/utils/table_to_list_of_lists.py,sha256=TKllsvcyGlTBbR_nJBu7hY0cUw_PGoGYV-xFrbspRc8,7047
+list_picker/utils/utils.py,sha256=euZYNGJiGViq84h8LGpaDO061IL9mFSINgSy6_yaqjc,9370
+listpick-0.1.4.0.dist-info/METADATA,sha256=InM8DzyAV-NN3UNuOHaOI6n5pKOt_Shdfo-Jm5YYzCY,7126
+listpick-0.1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+listpick-0.1.4.0.dist-info/top_level.txt,sha256=HY8phc8kRMVcP4QE5WA2HmjFJ4kmDJ7N7-RNUKQCOnc,12
+listpick-0.1.4.0.dist-info/RECORD,,

listpick-0.1.4.0.dist-info/WHEEL

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

listpick-0.1.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+list_picker