fpptools 0.2.0__tar.gz → 0.2.1__tar.gz

{fpptools-0.2.0 → fpptools-0.2.1}/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## 0.2.0 (unreleased)
+## 0.2.1 (unreleased)
+
+### Added
+- Documentation in `docs/` (one page per command, common options, exes, development). The README is now a short overview that links to it (absolute GitHub links, so they work on PyPI too); `docs/` is in the sdist.
+
+### Changed
+- `wipe kits --help` explains `--source`.
+- `scripts\build_exe.ps1` builds the exes into `dist_exe\`, leaving `dist\` for the PyPI wheel/sdist.
+- Project URL: github.com/andoresuperesu/fpptools.
+- Author email: me@aperezc.xyz.
+
+## 0.2.0 (2026-11-05)
 
 Rewrite for current Python and FP Pro 11.
 

fpptools-0.2.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.5
+Name: fpptools
+Version: 0.2.1
+Summary: Administration and debugging CLI for emmegisoft FP Pro (structures, blocks, jobs)
+Project-URL: Repository, https://github.com/andoresuperesu/fpptools
+Author-email: Andres Perez <me@aperezc.xyz>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: lxml>=5.0
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: pymysql>=1.1
+Requires-Dist: pyodbc>=5.0; sys_platform == 'win32'
+Description-Content-Type: text/markdown
+
+# fpptools
+
+Administration and debugging command line for emmegisoft **FP Pro**: structures (`.STR`), blocks (`.BLK`) and job records.
+It works on the configuration that is **active in FP Pro right now** (read from `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`).
+
+📖 **Full documentation:** [docs/](https://github.com/andoresuperesu/fpptools/blob/master/docs/README.md) · *Guía rápida en español más abajo.*
+
+## Install
+
+```powershell
+pip install fpptools          # or: uv tool install fpptools
+fpptools --help
+```
+
+No Python on the PC? Use the standalone exes: `fpptools.exe` (full command line) and `fpptools_estructuras.exe` (double-click: structures to `estructuras.xlsx`). See [Standalone exes](https://github.com/andoresuperesu/fpptools/blob/master/docs/exe.md).
+
+## Commands
+
+| Command | What it does | Docs |
+|---|---|---|
+| `fpptools config` | Show the active configuration: INI, folders, database (password hidden). Run it first when something isn't found | [config](https://github.com/andoresuperesu/fpptools/blob/master/docs/config.md) |
+| `fpptools str list` | Structures: folder, name, unique code (*nombre unívoco*), description → `structures.csv` | [str list](https://github.com/andoresuperesu/fpptools/blob/master/docs/str-list.md) |
+| `fpptools fit list` | Fittings used in structures, blocks, one job or all jobs (`--source str\|blk\|job\|jobs`), kits expanded from the database → `fittings_<source>.csv` | [fit list](https://github.com/andoresuperesu/fpptools/blob/master/docs/fit-list.md) |
+| `fpptools wipe panedefs` | Remove glass fittings, glass DXF and pane table from every pane of the structures | [wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md) |
+| `fpptools wipe kits` | Remove every kit from structures or blocks (`--source str\|blk`) | [wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md) |
+| `fpptools-estructuras` | Same as `str list --lang es -o estructuras.xlsx` (what the double-click exe runs) | [exe](https://github.com/andoresuperesu/fpptools/blob/master/docs/exe.md) |
+| `fpptools list_fittings` | 0.1 syntax (`--searchtype`), deprecated: use `fit list` | [fit list](https://github.com/andoresuperesu/fpptools/blob/master/docs/fit-list.md#01-syntax-list_fittings) |
+
+**Common options** ([details](https://github.com/andoresuperesu/fpptools/blob/master/docs/options.md)):
+
+- Choose files: `--under FOLDER`, `--match PATTERN`, `--root FOLDER`.
+- Output: `-o file.csv` / `file.xlsx` / `-` (console); CSV with `;` and UTF-8 BOM (opens right in Excel); `--lang es` for Spanish headers.
+- `--ini PATH` (or `FPPTOOLS_INI`): another FP_PRO.INI · `--version` · `-h` / `--help` on every command · `python -m fpptools` = `fpptools`.
+
+**Commands that modify files only simulate** unless you add `--apply`; with `--apply` the originals are backed up first ([wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md)).
+
+```powershell
+fpptools config
+fpptools str list --lang es -o estructuras.xlsx
+fpptools fit list --source blk -o fittings_blk.xlsx
+fpptools wipe panedefs --under "LINEA X"            # simulation
+fpptools wipe panedefs --under "LINEA X" --apply    # backup + write
+```
+
+---
+
+## Guía rápida (español)
+
+`fpptools` trabaja sobre la configuración **activa en FP Pro**. `fpptools config` muestra cuál es (carpetas y base de datos).
+
+**Exportar nombre y descripción de las estructuras:**
+
+```powershell
+fpptools str list --lang es -o estructuras.xlsx
+fpptools str list --under 019_SERIE_22_PESADO --lang es -o serie22.csv
+```
+
+Columnas: Carpeta, Nombre (nombre del archivo), Nombre único (nombre unívoco), Descripción.
+
+**Sin línea de comandos:** doble clic en `fpptools_estructuras.exe`. Crea `estructuras.xlsx` en la misma carpeta del programa (si está abierto en Excel, crea `estructuras_<fecha_hora>.xlsx`). El programa debe estar en una carpeta donde se pueda escribir (no en `C:\Program Files`).
+
+**Accesorios:** `fpptools fit list --source str|blk|job|jobs --lang es -o accesorios.xlsx`.
+
+**Comandos que modifican archivos** (`wipe`): por defecto solo **simulan** y muestran qué cambiarían. Con `--apply` primero copian los originales a `fpptools_backups\<fecha_hora>\` y luego escriben. Cierre las estructuras en FP Pro antes de aplicar.
+
+Documentación completa (en inglés): [docs/](https://github.com/andoresuperesu/fpptools/blob/master/docs/README.md).
+
+## Development
+
+See [docs/development.md](https://github.com/andoresuperesu/fpptools/blob/master/docs/development.md) (uv, tests, exes, PyPI).
+
+License: MIT.

fpptools-0.2.1/README.md

@@ -0,0 +1,72 @@
+# fpptools
+
+Administration and debugging command line for emmegisoft **FP Pro**: structures (`.STR`), blocks (`.BLK`) and job records.
+It works on the configuration that is **active in FP Pro right now** (read from `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`).
+
+📖 **Full documentation:** [docs/](https://github.com/andoresuperesu/fpptools/blob/master/docs/README.md) · *Guía rápida en español más abajo.*
+
+## Install
+
+```powershell
+pip install fpptools          # or: uv tool install fpptools
+fpptools --help
+```
+
+No Python on the PC? Use the standalone exes: `fpptools.exe` (full command line) and `fpptools_estructuras.exe` (double-click: structures to `estructuras.xlsx`). See [Standalone exes](https://github.com/andoresuperesu/fpptools/blob/master/docs/exe.md).
+
+## Commands
+
+| Command | What it does | Docs |
+|---|---|---|
+| `fpptools config` | Show the active configuration: INI, folders, database (password hidden). Run it first when something isn't found | [config](https://github.com/andoresuperesu/fpptools/blob/master/docs/config.md) |
+| `fpptools str list` | Structures: folder, name, unique code (*nombre unívoco*), description → `structures.csv` | [str list](https://github.com/andoresuperesu/fpptools/blob/master/docs/str-list.md) |
+| `fpptools fit list` | Fittings used in structures, blocks, one job or all jobs (`--source str\|blk\|job\|jobs`), kits expanded from the database → `fittings_<source>.csv` | [fit list](https://github.com/andoresuperesu/fpptools/blob/master/docs/fit-list.md) |
+| `fpptools wipe panedefs` | Remove glass fittings, glass DXF and pane table from every pane of the structures | [wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md) |
+| `fpptools wipe kits` | Remove every kit from structures or blocks (`--source str\|blk`) | [wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md) |
+| `fpptools-estructuras` | Same as `str list --lang es -o estructuras.xlsx` (what the double-click exe runs) | [exe](https://github.com/andoresuperesu/fpptools/blob/master/docs/exe.md) |
+| `fpptools list_fittings` | 0.1 syntax (`--searchtype`), deprecated: use `fit list` | [fit list](https://github.com/andoresuperesu/fpptools/blob/master/docs/fit-list.md#01-syntax-list_fittings) |
+
+**Common options** ([details](https://github.com/andoresuperesu/fpptools/blob/master/docs/options.md)):
+
+- Choose files: `--under FOLDER`, `--match PATTERN`, `--root FOLDER`.
+- Output: `-o file.csv` / `file.xlsx` / `-` (console); CSV with `;` and UTF-8 BOM (opens right in Excel); `--lang es` for Spanish headers.
+- `--ini PATH` (or `FPPTOOLS_INI`): another FP_PRO.INI · `--version` · `-h` / `--help` on every command · `python -m fpptools` = `fpptools`.
+
+**Commands that modify files only simulate** unless you add `--apply`; with `--apply` the originals are backed up first ([wipe](https://github.com/andoresuperesu/fpptools/blob/master/docs/wipe.md)).
+
+```powershell
+fpptools config
+fpptools str list --lang es -o estructuras.xlsx
+fpptools fit list --source blk -o fittings_blk.xlsx
+fpptools wipe panedefs --under "LINEA X"            # simulation
+fpptools wipe panedefs --under "LINEA X" --apply    # backup + write
+```
+
+---
+
+## Guía rápida (español)
+
+`fpptools` trabaja sobre la configuración **activa en FP Pro**. `fpptools config` muestra cuál es (carpetas y base de datos).
+
+**Exportar nombre y descripción de las estructuras:**
+
+```powershell
+fpptools str list --lang es -o estructuras.xlsx
+fpptools str list --under 019_SERIE_22_PESADO --lang es -o serie22.csv
+```
+
+Columnas: Carpeta, Nombre (nombre del archivo), Nombre único (nombre unívoco), Descripción.
+
+**Sin línea de comandos:** doble clic en `fpptools_estructuras.exe`. Crea `estructuras.xlsx` en la misma carpeta del programa (si está abierto en Excel, crea `estructuras_<fecha_hora>.xlsx`). El programa debe estar en una carpeta donde se pueda escribir (no en `C:\Program Files`).
+
+**Accesorios:** `fpptools fit list --source str|blk|job|jobs --lang es -o accesorios.xlsx`.
+
+**Comandos que modifican archivos** (`wipe`): por defecto solo **simulan** y muestran qué cambiarían. Con `--apply` primero copian los originales a `fpptools_backups\<fecha_hora>\` y luego escriben. Cierre las estructuras en FP Pro antes de aplicar.
+
+Documentación completa (en inglés): [docs/](https://github.com/andoresuperesu/fpptools/blob/master/docs/README.md).
+
+## Development
+
+See [docs/development.md](https://github.com/andoresuperesu/fpptools/blob/master/docs/development.md) (uv, tests, exes, PyPI).
+
+License: MIT.

fpptools-0.2.1/docs/README.md

@@ -0,0 +1,15 @@
+# fpptools documentation
+
+fpptools works on the FP Pro configuration that is **active right now** (`%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`): its folders (`STR_PATH`, `BLK_PATH`, `JOB_PATH`) and its database.
+
+| Page | Contents |
+|---|---|
+| [config](config.md) | `fpptools config`: which configuration, folders and database fpptools will use |
+| [str list](str-list.md) | Structures: folder, name, unique code, description (the Estructura browser) |
+| [fit list](fit-list.md) | Fittings in structures, blocks and job records; kits from the database; the 0.1 `list_fittings` syntax |
+| [wipe](wipe.md) | `wipe panedefs`, `wipe kits`: simulation, `--apply`, backups, reports |
+| [options](options.md) | Options common to all commands: choosing files, output formats, `--ini`, `--version`, errors |
+| [exe](exe.md) | Standalone `fpptools.exe` and the double-click `fpptools_estructuras.exe` |
+| [development](development.md) | uv, tests, building the exes, publishing to PyPI |
+
+Every command also explains itself: `fpptools <command> --help` (e.g. `fpptools fit list --help`).

fpptools-0.2.1/docs/config.md

@@ -0,0 +1,28 @@
+# `fpptools config`
+
+Shows the FP Pro configuration fpptools will use, without changing anything. **Run it first** when a command says a folder or the database can't be found.
+
+```powershell
+fpptools config
+```
+
+```
+INI             C:\Users\<you>\AppData\Roaming\Emmegisoft\FP_PRO\FP_PRO.INI
+Configuration   COLOMBIA_ALUMINA_MM
+STR_PATH        D:\CONFIGS11\COLOMBIA_ALUMINA_MM\STR\
+BLK_PATH        D:\CONFIGS11\COLOMBIA_ALUMINA_MM\BLK\
+JOB_PATH        D:\CONFIGS11\COLOMBIA_ALUMINA_MM\JOB\
+CONFIGS_PATH    C:\FP_PRO\CONFIGS\
+Database        MySQL localhost:3307/fp_pro32_colombia_alumina_mm (user …, charset latin1)
+```
+
+| Line | From FP_PRO.INI |
+|---|---|
+| INI | the file read: `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`, or `--ini` / `FPPTOOLS_INI` |
+| Configuration | `[GENERAL] CURRENT_CONFIGURATION` |
+| STR_PATH, BLK_PATH, JOB_PATH, CONFIGS_PATH | `[SYSTEM]`; `[not found]` after a folder that doesn't exist |
+| Database | `[SYSTEM] CONN_STR_FP_PRO`: `1` MySQL (`[MYSQL]` DB_SERVER_NAME, DB_PORT, DB_NAME, DB_USER, DB_CHARSET; port 3306 and charset latin1 when missing), `0` Access (`Fp_Pro32.MDB` in `MDB_PATH`) |
+
+The password is never shown or written anywhere.
+
+To work on another configuration, switch it in FP Pro, or point fpptools at another INI: `fpptools --ini D:\otro\FP_PRO.INI config`.

fpptools-0.2.1/docs/development.md

@@ -0,0 +1,30 @@
+# Development
+
+```powershell
+uv sync                     # .venv with the dev group (pytest)
+uv run pytest
+uv run fpptools --help
+```
+
+- Python ≥ 3.10, packaging with uv + hatchling. The version is in `fpptools/__init__.py`; record changes in `CHANGELOG.md`.
+- Tests use generic fixtures only (`tests/conftest.py`), never client files.
+- Layout and rules for contributors (and Claude): [`CLAUDE.md`](../CLAUDE.md).
+
+## Standalone exes
+
+```powershell
+.\scripts\build_exe.ps1     # dist_exe\fpptools.exe, dist_exe\fpptools_estructuras.exe
+```
+
+PyInstaller (`build` dependency group), one file each, console. They go to `dist_exe\`, **not** `dist\`, because `dist\` is for PyPI. The entry scripts are `scripts\exe_*.py` (outside the package on purpose).
+
+## PyPI
+
+```powershell
+uv build                                         # dist\fpptools-X.Y.Z.tar.gz + .whl
+uv publish --token pypi-XXXX dist\fpptools-X.Y.Z*
+```
+
+- A published version can't be replaced: fix → bump the version.
+- The README is the PyPI page: links to these docs are absolute GitHub links.
+- Keep the package name `fpptools`, the `fpptools` command and old commands (hidden aliases when renaming).

fpptools-0.2.1/docs/exe.md

@@ -0,0 +1,18 @@
+# Standalone exes
+
+For PCs without Python. Built with `scripts\build_exe.ps1` (see [development](development.md)) into `dist_exe\`; sent separately, not on PyPI.
+
+| Exe | |
+|---|---|
+| `fpptools.exe` | the full command line: `fpptools.exe str list --lang es -o estructuras.xlsx`, `fpptools.exe config`… |
+| `fpptools_estructuras.exe` | **double-click**: exports the structures of the active configuration to `estructuras.xlsx` **next to the exe** |
+
+## `fpptools_estructuras.exe`
+
+Same as `fpptools str list --lang es -o estructuras.xlsx` (columns in [str list](str-list.md)), for users who don't use the command line:
+
+- Takes the configuration active in FP Pro.
+- Writes `estructuras.xlsx` in the exe's folder; if that file is open in Excel, writes `estructuras_<YYYYMMDD_HHMMSS>.xlsx` instead.
+- The window stays open at the end (`Pulse Enter para cerrar…`) with `Listo: <file>` or the error.
+- The exe must be in a folder where the user can write (not `C:\Program Files`).
+- With Python installed, the same is the `fpptools-estructuras` command.

fpptools-0.2.1/docs/fit-list.md

@@ -0,0 +1,56 @@
+# `fpptools fit list`
+
+Lists every fitting used, one row per fitting.
+
+```powershell
+fpptools fit list                                   # structures -> fittings_str.csv
+fpptools fit list --source blk -o fittings_blk.xlsx
+fpptools fit list --source job --job 27002_6 -o -
+fpptools fit list --source jobs
+fpptools fit list --under "LINEA X" --no-db
+```
+
+## `--source`
+
+| Value | What it scans | Folder (FP_PRO.INI) | Columns |
+|---|---|---|---|
+| `str` (default) | every structure `.STR` | `STR_PATH` | Folder, File, Fitting, Source, Note |
+| `blk` | every block `.BLK` | `BLK_PATH` | Folder, File, Fitting, Source, Note |
+| `job` | the job records of one job (`--job NAME`, asked if missing) | `JOB_PATH` | Job, Item, Fitting, Source |
+| `jobs` | the job records of every job | `JOB_PATH` | Job, Item, Fitting, Source |
+
+- **Source** is the element the fitting hangs from, as `<element>:<code>` (e.g. `FP_NODE:10`), or `FP_KIT:<kit>` for fittings that come from a kit.
+- **Note** says when a kit is not in the database, or when `--no-db` was used (the kit is listed but not expanded).
+- Job records are found as `<JOB>_JOBRECORD*.XML` under `JOB_PATH` (as in 0.1; not yet checked on FP Pro 11).
+
+## Kits and the database
+
+Kits in STR/BLK files are expanded from the database of the active configuration (tables `kit` / `dettagliokit`): one row per fitting of the kit. Fittings written inside a kit in the file are not listed again.
+
+- MySQL (`CONN_STR_FP_PRO=1`): settings from `[MYSQL]` (see [config](config.md)).
+- Access (`CONN_STR_FP_PRO=0`): `Fp_Pro32.MDB` in `MDB_PATH`; needs the Microsoft Access ODBC driver with the same bitness (32/64-bit) as Python or the exe.
+- Queries are read-only (SELECT only).
+- `--no-db` skips the database (e.g. no access to the server).
+
+## Options
+
+| Option | Default | |
+|---|---|---|
+| `--source str\|blk\|job\|jobs` | `str` | see above |
+| `--job NAME` | asked | job for `--source job` |
+| `--no-db` | off | don't read the database; kits listed, not expanded |
+| `--under`, `--match`, `--root` | | `str` and `blk` only, see [options](options.md) |
+| `-o`, `--out` | `fittings_<source>.csv` | `.csv`, `.xlsx` or `-` |
+| `--lang en\|es` | `en` | column headers |
+
+A file that can't be read gets a row with the reason in **Note** and a `warning:` line; the rest goes on.
+
+## 0.1 syntax (`list_fittings`)
+
+`fpptools list_fittings --searchtype str|blk|job|jobs [--tofile y|n] [--verbose y|n]` still works (hidden, deprecated; it prints a reminder):
+
+| 0.1 | Now |
+|---|---|
+| `--searchtype X` | `fit list --source X` |
+| `--tofile y` (default) | writes `fittinglist_<X>.csv` |
+| `--verbose y` (or `--tofile n`) | prints to the console (`-o -`) |

fpptools-0.2.1/docs/options.md

@@ -0,0 +1,41 @@
+# Common options
+
+## Configuration
+
+| Option | |
+|---|---|
+| (none) | the configuration active in FP Pro: `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI` |
+| `--ini PATH` | another FP_PRO.INI; goes **before** the command: `fpptools --ini D:\x\FP_PRO.INI str list` |
+| `FPPTOOLS_INI` | environment variable, same as `--ini` |
+
+Nothing is read until a command needs it, so `--help` and `--version` work on a PC without FP Pro.
+
+## Choosing files (`str list`, `fit list` str/blk, `wipe`)
+
+| Option | |
+|---|---|
+| `--under FOLDER` | only inside that folder, relative to the root, e.g. `019_SERIE_22_PESADO` or `LINEA SUPERIOR/SERIE 35` (either slash, case-insensitive) |
+| `--match PATTERN` | file name without extension, wildcards `*` `?`, case-insensitive, e.g. `"VTA_*"` |
+| `--root FOLDER` | scan this folder instead of `STR_PATH` / `BLK_PATH` / `JOB_PATH` (e.g. a copy of a configuration) |
+
+## Output (`str list`, `fit list`)
+
+| `-o` / `--out` | |
+|---|---|
+| `file.csv` | `;` separated, UTF-8 with BOM, CRLF: Excel opens it with accents and columns right (Spanish/Italian locale) |
+| `file.xlsx` | Excel workbook: frozen header row, filters, column widths |
+| `-` | the console (`;` separated) |
+
+Defaults: `structures.csv`, `fittings_<source>.csv`, in the current folder. `--lang es` writes Spanish headers.
+
+Progress bars and `warning:` lines go to the error stream (stderr), so `-o -` output can be redirected cleanly: `fpptools str list -o - > estructuras.csv`.
+
+## General
+
+| | |
+|---|---|
+| `--version` | prints the version |
+| `-h`, `--help` | on every command and group: `fpptools wipe kits --help` |
+| `python -m fpptools …` | same as `fpptools …` (when the command isn't on the PATH) |
+
+Errors (INI not found, folder missing, database unreachable) print one `Error:` line, no traceback, and exit with code 1.

fpptools-0.2.1/docs/str-list.md

@@ -0,0 +1,39 @@
+# `fpptools str list`
+
+Lists the structures (`.STR`) of `STR_PATH`: the same data as FP Pro's **Estructura** browser.
+
+```powershell
+fpptools str list                                               # -> structures.csv
+fpptools str list --lang es -o estructuras.xlsx
+fpptools str list --under 019_SERIE_22_PESADO --match "VTA_*" -o -
+```
+
+## Columns
+
+| Column (`--lang es`) | Where it comes from |
+|---|---|
+| Folder (Carpeta) | folder of the file inside `STR_PATH` (the tree in the browser), e.g. `019_SERIE_22_PESADO\VENTANA_PROYECTABLE_S22` |
+| Name (Nombre) | file name without `.STR` (the "Nombre" field in FP Pro) |
+| Unique code (Nombre único) | `FP_TREE/@NameStr` (FP Pro's "nombre unívoco"). Not enforced unique: two structures can share it, and it can be empty |
+| Description (Descripción) | `FP_TREE/FP_DESCRIPTION`, stored as Base64 inside the file and decoded |
+| Error | only when some file couldn't be read: the reason, on that file's row |
+
+Facade structures (`FP_FACADE` files) are included.
+
+## Options
+
+| Option | Default | |
+|---|---|---|
+| `--under FOLDER` | all | only that folder of the tree (either slash, case-insensitive) |
+| `--match PATTERN` | all | file name without extension, `*` and `?` wildcards, case-insensitive |
+| `--root FOLDER` | `STR_PATH` | scan another folder (e.g. a copy) |
+| `-o`, `--out` | `structures.csv` | `.csv`, `.xlsx` or `-` (console) |
+| `--lang en\|es` | `en` | column headers |
+
+See [options](options.md) for the output format.
+
+## When a file can't be read
+
+The export goes on: the row is kept with an **Error** column, and a `warning:` line is printed for each such file. The summary at the end says how many had errors.
+
+For a double-click export without the command line, see [`fpptools_estructuras.exe`](exe.md).

fpptools-0.2.1/docs/wipe.md

@@ -0,0 +1,44 @@
+# `fpptools wipe`
+
+Commands that **modify** FP Pro files. They **only simulate** unless you add `--apply`.
+
+| Command | Files | What is removed |
+|---|---|---|
+| `wipe panedefs` | structures (`.STR`) | from every pane (`FP_NODE ElementType="8650"`): its glass fittings (`FP_FITTING` directly under the pane), the glass DXF (`DXF` of `FP_PIECE Type="8510"`) and the pane table (`PaneTableCode`). Leaves a reusable base that can't be used without re-checking glass and pane table |
+| `wipe kits` | structures (`--source str`, default) or blocks (`--source blk`) | every kit (`FP_KIT` with its content) |
+
+```powershell
+fpptools wipe panedefs --under "LINEA X"                       # simulation
+fpptools wipe panedefs --under "LINEA X" --report informe.txt  # simulation, report saved
+fpptools wipe panedefs --under "LINEA X" --apply               # backup + write
+fpptools wipe kits --source blk --match "BLK_OLD_*" --apply
+```
+
+**Close the structures/blocks in FP Pro before `--apply`.**
+
+## Simulation (default)
+
+Prints, per file, what would change (e.g. `pane 7: glass DXF GLASSES\ST4_4.DXF removed`) and the total:
+`703 file(s) would change, 6826 change(s).` Nothing is written. `--report FILE` also saves that report to a file (UTF-8). With nothing to change: `Nothing to change in N file(s).`
+
+## `--apply`
+
+1. **Backup first:** every file that will change is copied to `--backup-dir` (default `.\fpptools_backups`, in the current folder) under a new `<YYYYMMDD_HHMMSS>\` folder, keeping its sub-folders, together with `report.txt`. If the backup can't be made, nothing is written.
+2. **Then write:** each file is written to a temporary file and swapped in.
+3. **FP Pro's format is kept:** XML declaration, windows-1252, line endings (also inside CDATA), `<X/>` vs `<X />` and `<X></X>` as in the original. Only the lines of the removed parts change; an untouched file stays byte-identical.
+
+The backup folder **can't be inside the scanned folder** (FP Pro would list the backups as structures): fpptools refuses and asks for another `--backup-dir`.
+
+**To undo:** copy the files from the backup folder back over the originals (same sub-folders).
+
+## Options
+
+| Option | Default | |
+|---|---|---|
+| `--apply` | off | write (after the backup) |
+| `--backup-dir DIR` | `fpptools_backups` | where `--apply` copies the originals |
+| `--report FILE` | none | save the simulation report |
+| `--source str\|blk` | `str` | `wipe kits` only |
+| `--under`, `--match`, `--root` | | see [options](options.md) |
+
+A file that can't be parsed is skipped with a `warning:` line; the others go on.

{fpptools-0.2.0 → fpptools-0.2.1}/fpptools/__init__.py

@@ -1,3 +1,3 @@
 """fpptools: administration and debugging CLI for emmegisoft FP Pro."""
 
-__version__ = "0.2.0"
+__version__ = "0.2.1"

{fpptools-0.2.0 → fpptools-0.2.1}/fpptools/commands/wipe.py

@@ -113,7 +113,8 @@ def panedefs_cmd(app: App, root, under, match, apply, backup_dir, report):
 
 
 @wipe_group.command("kits")
-@click.option("--source", type=click.Choice(["str", "blk"]), default="str", show_default=True)
+@click.option("--source", type=click.Choice(["str", "blk"]), default="str", show_default=True,
+              help="Structures (STR_PATH) or blocks (BLK_PATH).")
 @scope_options
 @apply_options
 @pass_app

{fpptools-0.2.0 → fpptools-0.2.1}/pyproject.toml

@@ -5,7 +5,7 @@ description = "Administration and debugging CLI for emmegisoft FP Pro (structure
 readme = "README.md"
 license = "MIT"
 license-files = ["LICENSE"]
-authors = [{ name = "Andres Perez", email = "andresperezcera@gmail.com" }]
+authors = [{ name = "Andres Perez", email = "me@aperezc.xyz" }]
 requires-python = ">=3.10"
 classifiers = [
     "Topic :: Utilities",
@@ -43,7 +43,7 @@ build-backend = "hatchling.build"
 path = "fpptools/__init__.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["fpptools", "tests", "scripts", "README.md", "LICENSE", "CHANGELOG.md"]
+include = ["fpptools", "tests", "scripts", "docs", "README.md", "LICENSE", "CHANGELOG.md"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["fpptools"]

fpptools-0.2.0/PKG-INFO

@@ -1,129 +0,0 @@
-Metadata-Version: 2.5
-Name: fpptools
-Version: 0.2.0
-Summary: Administration and debugging CLI for emmegisoft FP Pro (structures, blocks, jobs)
-Project-URL: Repository, https://github.com/andoresuperesu/fpptools
-Author-email: Andres Perez <andresperezcera@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Classifier: Environment :: Console
-Classifier: Environment :: Win32 (MS Windows)
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Requires-Python: >=3.10
-Requires-Dist: click>=8.1
-Requires-Dist: lxml>=5.0
-Requires-Dist: openpyxl>=3.1
-Requires-Dist: pymysql>=1.1
-Requires-Dist: pyodbc>=5.0; sys_platform == 'win32'
-Description-Content-Type: text/markdown
-
-# fpptools
-
-Administration and debugging command line for emmegisoft **FP Pro**: structures (`.STR`), blocks (`.BLK`) and job records.
-It works on the configuration that is **active in FP Pro right now** (read from `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`).
-
-*Guía rápida en español más abajo.*
-
-## Install
-
-```powershell
-pip install fpptools          # or: uv tool install fpptools
-fpptools --help
-```
-
-Standalone exes (no Python needed) are built with `scripts\build_exe.ps1`:
-
-- `fpptools.exe`: the full command line.
-- `fpptools_estructuras.exe`: **double-click** to export the structures of the active configuration to `estructuras.xlsx` next to the exe (same as `fpptools str list --lang es -o estructuras.xlsx`). If that file is open in Excel, it writes `estructuras_<date_time>.xlsx` instead. Also installed as the `fpptools-estructuras` command.
-
-## Commands
-
-| Command | What it does |
-|---|---|
-| `fpptools config` | Show the active configuration: folders, database (password hidden) |
-| `fpptools str list` | List structures: folder, name, unique code, description |
-| `fpptools fit list` | List fittings used in structures, blocks, one job or all jobs (kits expanded from the database) |
-| `fpptools wipe panedefs` | Remove glass fittings, glass DXF and pane table from every pane of the structures |
-| `fpptools wipe kits` | Remove every kit from structures or blocks |
-
-Every command has `--help`.
-
-### Choosing files
-
-Commands that read STR/BLK folders accept:
-
-- `--under FOLDER`: only that folder of the tree, e.g. `--under 019_SERIE_22_PESADO`
-- `--match PATTERN`: file name pattern without extension, e.g. `--match "VTA_*"` (case-insensitive)
-- `--root FOLDER`: another folder instead of the one in FP_PRO.INI
-
-### Output
-
-`--out file.csv` (default), `--out file.xlsx`, or `--out -` for the console.
-CSV files use `;` and UTF-8 with BOM, so Excel opens them correctly with accents. `--lang es` writes Spanish headers.
-
-### Commands that modify files: simulate first
-
-`wipe` commands **only simulate** by default: they report what would change and write nothing.
-Add `--apply` to write. Before writing, every file is copied to `--backup-dir` (default `.\fpptools_backups\<date_time>\`, same sub-folders) together with a `report.txt`. To undo, copy the backed-up files back.
-
-```powershell
-fpptools wipe panedefs --under "LINEA X"            # simulation
-fpptools wipe panedefs --under "LINEA X" --apply    # backup + write
-```
-
-Close the structures in FP Pro before applying.
-
-### Structure fields
-
-| Column | Where it comes from |
-|---|---|
-| Folder | Folder of the file inside STR_PATH (the tree in FP Pro's structure browser) |
-| Name | File name without `.STR` (the "Nombre" field in FP Pro) |
-| Unique code | `FP_TREE/@NameStr` ("nombre unívoco" in FP Pro) |
-| Description | `FP_TREE/FP_DESCRIPTION`, stored as Base64 inside the file |
-
-### Database
-
-`fit list` reads kits from the FP Pro database of the active configuration: MySQL (`CONN_STR_FP_PRO=1`, settings in `[MYSQL]`) or Access (`Fp_Pro32.MDB` in `MDB_PATH`). Queries are read-only.
-Access needs the Microsoft Access ODBC driver with the same bitness (32/64-bit) as Python. Use `--no-db` to skip the database.
-
-### Other options
-
-- `--ini PATH` (or environment variable `FPPTOOLS_INI`): use another FP_PRO.INI.
-- `fpptools list_fittings --searchtype str` (0.1 syntax) still works but is deprecated.
-
----
-
-## Guía rápida (español)
-
-`fpptools` trabaja sobre la configuración **activa en FP Pro**.
-
-**Exportar nombre y descripción de las estructuras:**
-
-```powershell
-fpptools str list --lang es -o estructuras.xlsx
-fpptools str list --under 019_SERIE_22_PESADO --lang es -o serie22.csv
-```
-
-Columnas: Carpeta, Nombre (nombre del archivo), Nombre único (nombre unívoco), Descripción.
-
-**Sin línea de comandos:** doble clic en `fpptools_estructuras.exe`. Crea `estructuras.xlsx` en la misma carpeta del programa (si está abierto en Excel, crea `estructuras_<fecha_hora>.xlsx`). El programa debe estar en una carpeta donde se pueda escribir (no en `C:\Program Files`).
-
-**Comandos que modifican archivos** (`wipe`): por defecto solo **simulan** y muestran qué cambiarían. Con `--apply` primero copian los originales a `fpptools_backups\<fecha_hora>\` y luego escriben. Cierre las estructuras en FP Pro antes de aplicar.
-
-`fpptools config` muestra qué configuración, carpetas y base de datos está usando.
-
-## Development
-
-```powershell
-uv sync
-uv run pytest
-uv run fpptools --help
-uv build ; uv publish                     # PyPI
-.\scripts\build_exe.ps1                   # dist_exe\fpptools.exe, dist_exe\fpptools_estructuras.exe (not in dist\: that is PyPI's)
-```
-
-License: MIT.

fpptools-0.2.0/README.md

@@ -1,107 +0,0 @@
-# fpptools
-
-Administration and debugging command line for emmegisoft **FP Pro**: structures (`.STR`), blocks (`.BLK`) and job records.
-It works on the configuration that is **active in FP Pro right now** (read from `%APPDATA%\Emmegisoft\FP_PRO\FP_PRO.INI`).
-
-*Guía rápida en español más abajo.*
-
-## Install
-
-```powershell
-pip install fpptools          # or: uv tool install fpptools
-fpptools --help
-```
-
-Standalone exes (no Python needed) are built with `scripts\build_exe.ps1`:
-
-- `fpptools.exe`: the full command line.
-- `fpptools_estructuras.exe`: **double-click** to export the structures of the active configuration to `estructuras.xlsx` next to the exe (same as `fpptools str list --lang es -o estructuras.xlsx`). If that file is open in Excel, it writes `estructuras_<date_time>.xlsx` instead. Also installed as the `fpptools-estructuras` command.
-
-## Commands
-
-| Command | What it does |
-|---|---|
-| `fpptools config` | Show the active configuration: folders, database (password hidden) |
-| `fpptools str list` | List structures: folder, name, unique code, description |
-| `fpptools fit list` | List fittings used in structures, blocks, one job or all jobs (kits expanded from the database) |
-| `fpptools wipe panedefs` | Remove glass fittings, glass DXF and pane table from every pane of the structures |
-| `fpptools wipe kits` | Remove every kit from structures or blocks |
-
-Every command has `--help`.
-
-### Choosing files
-
-Commands that read STR/BLK folders accept:
-
-- `--under FOLDER`: only that folder of the tree, e.g. `--under 019_SERIE_22_PESADO`
-- `--match PATTERN`: file name pattern without extension, e.g. `--match "VTA_*"` (case-insensitive)
-- `--root FOLDER`: another folder instead of the one in FP_PRO.INI
-
-### Output
-
-`--out file.csv` (default), `--out file.xlsx`, or `--out -` for the console.
-CSV files use `;` and UTF-8 with BOM, so Excel opens them correctly with accents. `--lang es` writes Spanish headers.
-
-### Commands that modify files: simulate first
-
-`wipe` commands **only simulate** by default: they report what would change and write nothing.
-Add `--apply` to write. Before writing, every file is copied to `--backup-dir` (default `.\fpptools_backups\<date_time>\`, same sub-folders) together with a `report.txt`. To undo, copy the backed-up files back.
-
-```powershell
-fpptools wipe panedefs --under "LINEA X"            # simulation
-fpptools wipe panedefs --under "LINEA X" --apply    # backup + write
-```
-
-Close the structures in FP Pro before applying.
-
-### Structure fields
-
-| Column | Where it comes from |
-|---|---|
-| Folder | Folder of the file inside STR_PATH (the tree in FP Pro's structure browser) |
-| Name | File name without `.STR` (the "Nombre" field in FP Pro) |
-| Unique code | `FP_TREE/@NameStr` ("nombre unívoco" in FP Pro) |
-| Description | `FP_TREE/FP_DESCRIPTION`, stored as Base64 inside the file |
-
-### Database
-
-`fit list` reads kits from the FP Pro database of the active configuration: MySQL (`CONN_STR_FP_PRO=1`, settings in `[MYSQL]`) or Access (`Fp_Pro32.MDB` in `MDB_PATH`). Queries are read-only.
-Access needs the Microsoft Access ODBC driver with the same bitness (32/64-bit) as Python. Use `--no-db` to skip the database.
-
-### Other options
-
-- `--ini PATH` (or environment variable `FPPTOOLS_INI`): use another FP_PRO.INI.
-- `fpptools list_fittings --searchtype str` (0.1 syntax) still works but is deprecated.
-
----
-
-## Guía rápida (español)
-
-`fpptools` trabaja sobre la configuración **activa en FP Pro**.
-
-**Exportar nombre y descripción de las estructuras:**
-
-```powershell
-fpptools str list --lang es -o estructuras.xlsx
-fpptools str list --under 019_SERIE_22_PESADO --lang es -o serie22.csv
-```
-
-Columnas: Carpeta, Nombre (nombre del archivo), Nombre único (nombre unívoco), Descripción.
-
-**Sin línea de comandos:** doble clic en `fpptools_estructuras.exe`. Crea `estructuras.xlsx` en la misma carpeta del programa (si está abierto en Excel, crea `estructuras_<fecha_hora>.xlsx`). El programa debe estar en una carpeta donde se pueda escribir (no en `C:\Program Files`).
-
-**Comandos que modifican archivos** (`wipe`): por defecto solo **simulan** y muestran qué cambiarían. Con `--apply` primero copian los originales a `fpptools_backups\<fecha_hora>\` y luego escriben. Cierre las estructuras en FP Pro antes de aplicar.
-
-`fpptools config` muestra qué configuración, carpetas y base de datos está usando.
-
-## Development
-
-```powershell
-uv sync
-uv run pytest
-uv run fpptools --help
-uv build ; uv publish                     # PyPI
-.\scripts\build_exe.ps1                   # dist_exe\fpptools.exe, dist_exe\fpptools_estructuras.exe (not in dist\: that is PyPI's)
-```
-
-License: MIT.