ferp 0.7.1__py3-none-any.whl

ferp-0.7.1.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: ferp
+Version: 0.7.1
+Summary: Terminal-first file navigator and FSCP automation workbench built with Textual.
+Author: Brandon Johnson
+License: MIT
+Project-URL: Homepage, https://github.com/zappbrandigan/ferp
+Project-URL: Documentation, https://github.com/zappbrandigan/ferp#readme
+Project-URL: Issues, https://github.com/zappbrandigan/ferp/issues
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.21
+Requires-Dist: watchdog>=4.0
+Requires-Dist: textual>=7.4.0
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: requests>=2.32
+Provides-Extra: dev
+Requires-Dist: pypdf>=6.6; extra == "dev"
+Requires-Dist: extract-msg>=0.55.0; extra == "dev"
+Requires-Dist: openpyxl>=3.1; extra == "dev"
+Requires-Dist: xlwings>=0.33; extra == "dev"
+Requires-Dist: googletrans==4.0.2; extra == "dev"
+Requires-Dist: Unidecode>=1.3.8; extra == "dev"
+Requires-Dist: pywin32>=306; platform_system == "Windows" and extra == "dev"
+Requires-Dist: pdfplumber>=0.11.8; extra == "dev"
+Requires-Dist: reportlab>=4.4.9; extra == "dev"
+Requires-Dist: py7zr>=1.1.2; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: textual-dev>=1.8.0; extra == "dev"
+Dynamic: license-file
+
+# FER​P – For Executing Repetitive Processes
+
+FERP is a terminal-friendly file manager and automation workbench. It combines an interactive file navigator, contextual metadata inspection, and a protocol-driven script runner so you can explore directories and execute repeatable workflows through a TUI—without requiring terminal knowledge.
+
+## Highlights
+
+- **Keyboard-first navigation**
+  - A full list of keys are available in the app.
+- **Context panes**
+  - Script list reads from the user config `config.json` (platformdirs).
+  - Output panel streams FSCP results and records transcripts under the user data `logs` directory.
+  - README modal (Enter on a script) displays bundled documentation.
+- **Managed script runtime**
+  - Scripts execute via the FSCP host ↔ script protocol.
+  - Interactive prompts, confirmations, progress, and structured results are supported.
+  - Logs are timestamped and automatically pruned (default 50 files / 14 days).
+
+## Quick Start
+
+```bash
+pipx install ferp
+```
+
+> [!NOTE]
+> To use the default scripts, open the command palette (`Ctrl+P`) and select **Install/Update Default Scripts**.
+
+> [!WARNING]
+> This option is intended for users who do not wish to manage scripts manually. It will remove any existing scripts you have installed.
+>  
+> If you prefer to install scripts individually, create a bundle for the desired script using the source files from
+> [ferp-scripts](https://github.com/zappbrandigan/ferp-scripts).
+
+## Configuring Scripts
+
+Scripts are declared in your user config `config.json` (created on first script install). Each entry defines:
+
+- `script`: path to the executable (e.g. `scripts/ferp.zip_dir/script.py`).
+- `target`: `current_directory`, `highlighted_file`, or `highlighted_directory`.
+- `file_extensions`: optional list of suffixes (for `highlighted_file` targets).
+- Optional README at `scripts/<id>/readme.md`.
+
+Each script lives under `scripts/<id>/` (the directory name matches the fully-qualified ID, such as `ferp.zip_dir`). Inside the directory:
+
+- `script.py` contains the executable FSCP script.
+- `readme.md` provides the optional documentation shown inside FER​P.
+
+### Dev toggle for script config
+
+During development you can point FER​P at the repo copy of `ferp/scripts/config.json` instead of the user config file:
+
+```bash
+FERP_DEV_CONFIG=1 python -m ferp
+```
+
+When enabled, FER​P reads the config directly from the repository and skips the one-time copy into the user config directory.
+
+## Authoring FSCP Scripts
+
+Python scripts executed from FER​P speak the [FSCP](./ferp/fscp) protocol. See
+`SCRIPT_AUTHORS.md` for the SDK guide, examples, logging, cancellation, cleanup,
+and packaging details.
+
+## Terminal Commands
+
+FERP opens your system terminal in the current directory (shown in the top bar).
+
+- Open a terminal using `Ctrl+t`.
+- The spawned terminal inherits the current working directory.
+- On Windows system, prefers PowerShell and falls back to CommandPrompt.
+
+## Task List
+
+FERP includes a lightweight task list for quick capture and review.
+
+- Press `t` to add a task from anywhere in the UI.
+- Press `l` to open the task list and review or mark tasks as complete.
+- Tag tasks with `@` for text highlighting and filtering.
+- Toggle completion status with the space bar.
+- The task status indicator updates automatically as tasks are completed.
+
+## Other Features
+
+- **Script catalog refresh**: Reload the script list after editing config.
+- **Default script updates**: Pull the latest default scripts from the release feed.
+- **Process list**: View and stop running scripts from the command palette.
+- **Tasks**: Capture quick tasks and review them in the task list.
+- **Themes**: Switch themes from the command palette.
+- **Startup directory**: Set the default path Ferp opens on launch.
+- **Logs**: Open the latest transcript log from the command palette.

ferp-0.7.1.dist-info/RECORD

@@ -0,0 +1,87 @@
+ferp/__init__.py,sha256=OuqD7ccFgzZpmQpnGVPU2O_U2ITvETGXiWZ0KHN5j9g,64
+ferp/__main__.py,sha256=g5qi-I4ojhTuy_0u3bVskW8xnqLTAr3BbWfbsGsHT4A,65
+ferp/__version__.py,sha256=2KJZDSMOG7KS82AxYOrZ4ZihYxX0wjfUjDsIZh3L024,22
+ferp/app.py,sha256=z9oVlCS9ugtDgponbzXSaxzP-hY_d07XrthIiZmPmo0,110
+ferp/cli.py,sha256=fueoVXXwbX2Zv6eMMOv23z9PMSlCMVqHzTkjVBYIYxo,4796
+ferp/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/core/app.py,sha256=Ds-5nv4w-ar1tblkoI8z1K7oMM2c8BrPS6bhK0fIP4s,49372
+ferp/core/bundle_installer.py,sha256=V4BG-BlMvMbcNB2uFG1quQM-qqFDYj87nyusxvvDVUk,8674
+ferp/core/command_provider.py,sha256=Qs0BA41JCE8KT5PR1sP2X1LDc_U5vv_Y9cOYtJ6xvU0,2518
+ferp/core/dependency_manager.py,sha256=5pqsNYIE4sKuw7w5ckRPJPR0le8RcNQ4G2xPYZjKB8k,2191
+ferp/core/fs_controller.py,sha256=oM8cS_om92fk_m6QGAt5JyjYn4-fnWnGNf5FimFS1oU,1959
+ferp/core/fs_watcher.py,sha256=g4q6WXvgoanmhcshXMc3S0poQLIrQrQaQPg4v-nf1Mg,4861
+ferp/core/messages.py,sha256=lzqkG1WMBcaYx2srKOo5wmYRZK92j3Vvw1Kh9ZH7fJw,1185
+ferp/core/path_actions.py,sha256=uUSlBllrTH_Oh0XJ232iFm4FiywKlXcxAlmLlNUwgnQ,3945
+ferp/core/paths.py,sha256=nKvYBbk6ngmFbTYQlv56LdVqi-EK1mYzsurf-U6YTvE,114
+ferp/core/protocols.py,sha256=aGsM9zubcU1HiIu1wJvwc24xNWN8ZDZ6779cfKMWGs4,156
+ferp/core/script_controller.py,sha256=r1p35yAcSOnh2rXMMmVGkSD5XPSVHipSKMKaaN6H8HU,17654
+ferp/core/script_protocol.py,sha256=E2rYfg9h5XFrhpxbMP0gE6OAGRPlSohCYN427flRIdA,754
+ferp/core/script_runner.py,sha256=xjknf4bTz-PKboJ_ReLsLzTrpTrmBdVJK-GtdBdJXBQ,13782
+ferp/core/settings.py,sha256=zCY8lfYIXrPtELPc304cnuuPUKk1F7lUcvozznkVHhs,501
+ferp/core/settings_store.py,sha256=FfypSIdzHPeYexTFZrJxTQh-ia-ojppGQgxgNyfmf5M,2316
+ferp/core/state.py,sha256=l7uaQp9-82p-hAFClGshmX2WCYoCeLqSG8oDRQMYvcI,5196
+ferp/core/task_store.py,sha256=teMDEy9PT503cCXQV_rbS5R4iMxBsywzL0fxpBFY9ak,5182
+ferp/core/transcript_logger.py,sha256=kUreRHfGZE0EfX0U8ZC_itQ1yudsDOZoSuwjQG1Byas,2885
+ferp/domain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/domain/scripts.py,sha256=XkPoh_JPrSXuIYd9gJbZ4i5FpH2uwWklKwo3Hibv-6Q,563
+ferp/fscp/host/__init__.py,sha256=LU-IOmZEAVBhUhrVZLTN6rb-jwdR-dO68IL7bnRswLM,261
+ferp/fscp/host/host.py,sha256=SzesYOgcg7JU5p6N9vXaFdrbAQm27l84r50MT3ls_zI,15180
+ferp/fscp/host/managed_process.py,sha256=8x_tsu9hejIJstTKYu3YNr3uEm7x2cM5YmsjutXz1rE,3079
+ferp/fscp/host/process_registry.py,sha256=QFy7gnABUzsQyaeBnyBAvWExP_mm0OBjLhQ0hpb_rAM,3547
+ferp/fscp/protocol/__init__.py,sha256=7q4bujRjdnOq2q8jC3116ITN5JiiPxZ5EKje_WfZJW8,309
+ferp/fscp/protocol/errors.py,sha256=jNSgtCQe8WbSklZCv4dnec8HRlMutT6TqwqBuXioRyU,90
+ferp/fscp/protocol/messages.py,sha256=Q4ZRza3BFVN55YqqtfUv9pXrcHs47Qnw-tne7-5T2VQ,1331
+ferp/fscp/protocol/state.py,sha256=qCt82AGCZYJ6vl2FCvl5VBMjN361TjHVgBIkbhsg41o,544
+ferp/fscp/protocol/validator.py,sha256=93pvIyH63x9zAxiOAsUPvj3rTpxIgjrVTqLim1AiqyI,3442
+ferp/fscp/protocol/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/fscp/protocol/schemas/fscp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/fscp/protocol/schemas/fscp/1.0/cancel.json,sha256=dDa8sADAKQu7RKLILlnWLKzyupKWUce7240XWzhTpK0,352
+ferp/fscp/protocol/schemas/fscp/1.0/definitions.json,sha256=4b0kbetz9XU3Dbyd8jUvGZ5RqXiIWjVz9UI4zsthcAQ,553
+ferp/fscp/protocol/schemas/fscp/1.0/discriminator.json,sha256=9aU7UtltzQ43ZBqpRXfbOaT9OUiwISfE1Y8U-e3lSVs,397
+ferp/fscp/protocol/schemas/fscp/1.0/envelope.json,sha256=rE5ZBXMITEsFd0ceZa-cLS_K4032HsOZW5EZEsJ9P4Y,422
+ferp/fscp/protocol/schemas/fscp/1.0/exit.json,sha256=oeXhYuUd6TCf1Oijk9oJrQ0cG_v2br7B9sYf5be6YJM,461
+ferp/fscp/protocol/schemas/fscp/1.0/init.json,sha256=tLY7sjA7e5PHO5_5s_d_g5zGxVadGChrEY5ohSa-evc,963
+ferp/fscp/protocol/schemas/fscp/1.0/input_response.json,sha256=2A8P5b-ntyVNXRsOAuQEHfYy0drNH6uf2t9lJOyMJmg,528
+ferp/fscp/protocol/schemas/fscp/1.0/log.json,sha256=1q1wH98xePvN_c9raUxawkpXKpF9EZIF07xk1vydQ7k,548
+ferp/fscp/protocol/schemas/fscp/1.0/message.json,sha256=7wcoIPuyKSq33Lnn_ZiOQgLl0h2OXaxXMOvLLXyIVTI,520
+ferp/fscp/protocol/schemas/fscp/1.0/progress.json,sha256=0GBRO8GOs_cNXEJ-5STHB4j3y1PzLaI8ZdXaCUEieR8,632
+ferp/fscp/protocol/schemas/fscp/1.0/request_input.json,sha256=P-VWIsb3xyqiYQHhpb7hzKjRZoIjGB1m-mlYv5BX2Mw,1500
+ferp/fscp/protocol/schemas/fscp/1.0/result.json,sha256=wgCy-dfcGIhxvI8ZvH-9EGLU1tU6mFb0mXCRN-kdaBY,351
+ferp/fscp/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/fscp/scripts/sdk.py,sha256=SS_3swkT-obDp2GTQlEpan92YUEbg5dyPw7JyxgaPw4,17132
+ferp/fscp/scripts/runtime/__init__.py,sha256=sGCJ0hlraOzxRY6f-K7_6RICPnzAHDagZkgbJv9py1w,160
+ferp/fscp/scripts/runtime/__main__.py,sha256=yw2-x3n1DDLNuvzJU3ws4CfYvc9oypOiPzfSJF2OFEc,888
+ferp/fscp/scripts/runtime/errors.py,sha256=VbRdFwrov4kEFthaihDasGfNYpZjGLAK2_BRreHnjNY,357
+ferp/fscp/scripts/runtime/io.py,sha256=8g-mvXqguo9usgJqSrVaov-quyuQkBgtsMbAad_pKac,1705
+ferp/fscp/scripts/runtime/script.py,sha256=tNC83B1vTe71PWvlxiluZYAky-uGtWmpFEq-oTaYTHk,4583
+ferp/fscp/scripts/runtime/state.py,sha256=lbDbxm9Ssiyahx-njCv_z2cv1tfeaf_oSzq0ZFiQRVU,581
+ferp/fscp/scripts/runtime/worker.py,sha256=nsBkOyfAtFrkkpsPmzAXFUmMIiapJJg_u5Ro_pi_yXY,392
+ferp/fscp/transcript/__init__.py,sha256=QOAMyqzwkhwXjmPbM3UzSqxUfoApL9nzLOwKzIXIaRg,67
+ferp/fscp/transcript/events.py,sha256=aaWpUv4-Y5v5TX6TK-qgyxowCUnoi2I8DaVVcGVdJzM,322
+ferp/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ferp/services/__init__.py,sha256=xJEuxtPi8jqW-rSrKhW4trDmGFW4svSiW0blOpsy0K8,134
+ferp/services/file_listing.py,sha256=Jp__Qou4VSChHId-k6OADGug2Bm_-VIyvOsBrs6fpbM,3371
+ferp/services/monday_sync.py,sha256=e3xjIOXO9DF9nrZibTbaeekYA6-LYnHbd5OE8XDLnMM,4964
+ferp/services/releases.py,sha256=rakn0NvfSmKNswgXF3mZV34hOgPlr0ZRI2fZB0zdaCM,7393
+ferp/services/scripts.py,sha256=SiinZWVpXbNrTf_jVK_oP0oKDwvVMc9YYnXzHmgt78s,2929
+ferp/services/update_check.py,sha256=DRFzpbLtz_y_xwc_2z93LT2ZyfXRCHWcnysd_3kXGX8,3867
+ferp/styles/index.tcss,sha256=QX9MHi_0OGEIg8GhH9DQsCaEIkkHWfYxMYEVkKRoHdA,12865
+ferp/themes/themes.py,sha256=qxSz7NmDKI68IqwUfqrs91YDXulWzMl8dnNlWpjGCNc,5396
+ferp/widgets/__init__.py,sha256=PVqPghIlBgv2LIqGIl5wGpvso8PFJUscEZgO2Yg7hjU,445
+ferp/widgets/dialogs.py,sha256=VjomKWLZvKLEpZ_Nb5Bn6pCSYALacTk9egYZZsDkidM,5440
+ferp/widgets/file_tree.py,sha256=G7_ZENE03tbOJEXakDLcGzEhIn1nv6QhvuHFxfse9JQ,34383
+ferp/widgets/forms.py,sha256=wHIfygonoVt3o-6FT2oiFU4dju6ZAStVDA0KM6sU1xY,5030
+ferp/widgets/output_panel.py,sha256=zddbKg6EST0airyPSmEmMQ14fyPUbs762rIAH6D-DyA,9367
+ferp/widgets/panels.py,sha256=58Oq1_jpeYud4gTRZbae40kEDSd-E53i2FVRMVSqNgA,354
+ferp/widgets/process_list.py,sha256=uyDsEvGQ3v47CAhQ6iuJu3AHAY866MdkA6acL3fXQOo,5240
+ferp/widgets/readme_modal.py,sha256=W91wCUWebx12AgTJqYIvqblTvGrF7KysOR4fp1PU2dw,2199
+ferp/widgets/scripts.py,sha256=cpuN-7yi7bfYNBQWTzxpOUjjs2PArLhKJ4FUhFrUXps,6078
+ferp/widgets/task_capture.py,sha256=j9X-BenKs6NPbrk6lAaKWHD4XhYcuyldw_NNcQEEs-c,2366
+ferp/widgets/task_list.py,sha256=SYU1LVHyjuQQvHtfUjk_p-aoGdjVTBhP4FW75mdng1w,17288
+ferp/widgets/top_bar.py,sha256=sIw7ceCgsq7ChxK37N0QyfwiIk9ftNdcOZNYk3s1vlU,3349
+ferp-0.7.1.dist-info/licenses/LICENSE,sha256=coX1c1i5Os4wRPjOgz91IC9Mmf5sjSeBzd_XYUpRZC8,1071
+ferp-0.7.1.dist-info/METADATA,sha256=M5tM43LR-Z09OyWaT3Xs_e0zTLWhKhktB5VLjIq5OZM,5432
+ferp-0.7.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+ferp-0.7.1.dist-info/entry_points.txt,sha256=IpUreh27vY6rLqp2QA7ljAbt4vJRqOJQxVmvLdNa4_o,39
+ferp-0.7.1.dist-info/top_level.txt,sha256=eIJrCfqCLwNJCS_xJr4xH_X66Vn0gtcJE4yjsc0lJkQ,5
+ferp-0.7.1.dist-info/RECORD,,

ferp-0.7.1.dist-info/WHEEL

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

ferp-0.7.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ferp = ferp.cli:main

ferp-0.7.1.dist-info/licenses/LICENSE

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

ferp-0.7.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+ferp