fpptools 0.1.0__tar.gz → 0.2.0__tar.gz

fpptools-0.2.0/.gitignore

@@ -0,0 +1,119 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# 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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# fpptools runtime output
+fpptools_backups/
+*.fpptools.tmp
+
+# standalone exes (scripts/build_exe.ps1); dist/ holds only the PyPI wheel/sdist
+dist_exe/
+
+# outputs fpptools writes in the working folder, and archives
+*.7z
+estructuras*.xlsx
+structures.csv
+structures.xlsx
+fittings_*.csv
+fittinglist_*.csv

fpptools-0.2.0/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## 0.2.0 (unreleased)
+
+Rewrite for current Python and FP Pro 11.
+
+### Added
+- `fpptools str list`: structures with folder, name, unique code (NameStr) and description (decoded from Base64). CSV (`;`, UTF-8 BOM) or `.xlsx`, `--lang es`.
+- `fpptools_estructuras.exe` / `fpptools-estructuras`: double-click export of structures to `estructuras.xlsx` next to the exe.
+- `fpptools config`: show the active configuration (password hidden).
+- `fpptools wipe panedefs` and `fpptools wipe kits`: simulate by default; `--apply` backs up every file first and writes a report.
+- `--under`, `--match`, `--root` on every folder-scanning command; `--ini` / `FPPTOOLS_INI` on all commands.
+- Tests with generic fixtures.
+
+### Changed
+- `list_fittings` is now `fpptools fit list` (old syntax kept as a hidden, deprecated alias). Output is CSV with `;`; columns Folder, File, Fitting, Source, Note.
+- Job selection uses `--job NAME` (prompted if missing).
+- Rewritten files keep FP Pro's format: original XML declaration, windows-1252, CRLF.
+- Packaging: uv + hatchling, Python >= 3.10, click 8, lxml 5+, PyMySQL 1.x, pyodbc 5 (Windows only).
+
+### Fixed
+- Importing fpptools no longer reads FP_PRO.INI or connects to the database (`--help` works without FP Pro).
+- MySQL now uses `DB_PORT` and `DB_CHARSET` from FP_PRO.INI (defaults 3306 and latin1 when missing or empty).
+- Access kits query no longer exhausts its cursor after the first file.
+- Clean error messages instead of tracebacks when the INI, folders or database are missing.
+
+## 0.1.1
+
+- `list_fittings` for str/blk/job/jobs.

fpptools-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Andres Perez
+
+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.

fpptools-0.2.0/PKG-INFO

@@ -0,0 +1,129 @@
+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

@@ -0,0 +1,107 @@
+# 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/fpptools/__init__.py

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

fpptools-0.2.0/fpptools/__main__.py

@@ -0,0 +1,6 @@
+"""Allows `python -m fpptools` and is the PyInstaller entry script."""
+
+from fpptools.cli import main
+
+if __name__ == "__main__":
+    main()

fpptools-0.2.0/fpptools/app.py

@@ -0,0 +1,29 @@
+"""Shared CLI state passed to every command."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+from fpptools import config
+
+
+class App:
+    """The FP Pro configuration is loaded only when a command needs it."""
+
+    def __init__(self, ini: Path | None):
+        self._ini = ini
+        self._cfg: config.FppConfig | None = None
+
+    @property
+    def cfg(self) -> config.FppConfig:
+        if self._cfg is None:
+            self._cfg = config.load(self._ini)
+        return self._cfg
+
+    def root(self, kind: str, override: Path | None) -> Path:
+        return Path(override) if override else self.cfg.root_for(kind)
+
+
+pass_app = click.make_pass_decorator(App)

fpptools-0.2.0/fpptools/cli.py

@@ -0,0 +1,38 @@
+"""fpptools command line: `fpptools <group> <command>`.
+
+Groups: config, str, fit, wipe. Run `fpptools <group> --help` for details.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+from fpptools import __version__, config
+from fpptools.app import App
+from fpptools.commands import config_cmd, fit, str as str_cmd, wipe
+
+
+@click.group(context_settings={"help_option_names": ["-h", "--help"]})
+@click.version_option(__version__, prog_name="fpptools")
+@click.option("--ini", type=click.Path(dir_okay=False, path_type=Path), envvar=config.ENV_INI,
+              help="FP_PRO.INI to use. Default: the configuration FP Pro is using now.")
+@click.pass_context
+def cli(ctx: click.Context, ini: Path | None):
+    """Administration and debugging tools for emmegisoft FP Pro.
+
+    Works on the configuration currently active in FP Pro (FP_PRO.INI).
+    """
+    ctx.obj = App(ini)
+
+
+cli.add_command(config_cmd.config_show)
+cli.add_command(str_cmd.str_group)
+cli.add_command(fit.fit_group)
+cli.add_command(fit.legacy_list_fittings)
+cli.add_command(wipe.wipe_group)
+
+
+def main():
+    cli(prog_name="fpptools")

fpptools-0.2.0/fpptools/commands/__init__.py

@@ -0,0 +1,37 @@
+"""CLI command groups. Shared options live here."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+HEADERS = {
+    "en": {"folder": "Folder", "name": "Name", "unique": "Unique code", "description": "Description",
+           "file": "File", "fitting": "Fitting", "source": "Source", "note": "Note", "error": "Error",
+           "job": "Job", "item": "Item"},
+    "es": {"folder": "Carpeta", "name": "Nombre", "unique": "Nombre único", "description": "Descripción",
+           "file": "Archivo", "fitting": "Accesorio", "source": "Origen", "note": "Nota", "error": "Error",
+           "job": "Trabajo", "item": "Ítem"},
+}
+
+
+def scope_options(f):
+    """--root / --under / --match, shared by every command that walks STR/BLK folders."""
+    f = click.option("--match", metavar="PATTERN",
+                     help="Only files whose name (no extension) matches, e.g. 'VTA_*'. Case-insensitive.")(f)
+    f = click.option("--under", metavar="FOLDER",
+                     help="Only inside this folder, relative to the root, e.g. '019_SERIE_22_PESADO'.")(f)
+    f = click.option("--root", type=click.Path(file_okay=False, exists=True, path_type=Path),
+                     help="Folder to scan instead of the one in FP_PRO.INI.")(f)
+    return f
+
+
+def lang_option(f):
+    return click.option("--lang", type=click.Choice(["en", "es"]), default="en", show_default=True,
+                        help="Language of the column headers.")(f)
+
+
+def out_option(default: str):
+    return click.option("--out", "-o", default=default, show_default=True,
+                        help="Output file (.csv or .xlsx), or '-' for the console.")

fpptools-0.2.0/fpptools/commands/config_cmd.py

@@ -0,0 +1,36 @@
+"""`fpptools config`: show which FP Pro configuration fpptools will use."""
+
+from __future__ import annotations
+
+import click
+
+from fpptools.app import App, pass_app
+
+
+@click.command("config")
+@pass_app
+def config_show(app: App):
+    """Show the active FP Pro configuration (password hidden)."""
+    cfg = app.cfg
+
+    def line(label: str, value) -> None:
+        click.echo(f"{label:<16}{value}")
+
+    def folder(key: str) -> str:
+        value = cfg.get("SYSTEM", key)
+        if not value:
+            return "(not set)"
+        from pathlib import Path
+        return f"{value}" + ("" if Path(value).is_dir() else "   [not found]")
+
+    line("INI", cfg.ini_path)
+    line("Configuration", cfg.name or "(unknown)")
+    line("STR_PATH", folder("STR_PATH"))
+    line("BLK_PATH", folder("BLK_PATH"))
+    line("JOB_PATH", folder("JOB_PATH"))
+    line("CONFIGS_PATH", folder("CONFIGS_PATH"))
+    if cfg.db_kind == "mysql":
+        s = cfg.mysql
+        line("Database", f"MySQL {s.host}:{s.port}/{s.database} (user {s.user}, charset {s.charset})")
+    else:
+        line("Database", f"Access {cfg.mdb_file}" + ("" if cfg.mdb_file.is_file() else "   [not found]"))