From dece5ce04388e1c8b7e3299b33288632c6f75a33 Mon Sep 17 00:00:00 2001 From: Joshua Lucas Date: Wed, 14 Oct 2026 21:18:06 -0500 Subject: [PATCH] - Add Ruff rules to pyproject.toml. - Update readme. - Add launch.json for python debugging in VSCode. --- .vscode/launch.json | 16 ++++++++++++++++ pyproject.toml | 6 ++++++ readme.md | 26 +++++++++++++++++++++++--- 3 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 .vscode/launch.json diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..5c78ec1 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,16 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Python Debugger: Current File with Arguments", + "type": "debugpy", + "request": "launch", + "program": "${file}", + "console": "integratedTerminal", + "args": "${command:pickArgs}" + } + ] +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index b2a44b1..c28b99e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,12 @@ Issues = "https://github.com/jlucas-primecontrols/AuDaGe/issues" [tool.coverage.report] exclude_also = ['if __name__ == "__main__"', 'pass'] +[tool.ruff] +line-length = 80 + +[tool.ruff.lint.pep8-naming] +ignore-names = ["AuDaGe"] + [tool.setuptools.packages.find] where = ["src", "tests"] diff --git a/readme.md b/readme.md index fecd1fc..1f0ba6a 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,22 @@ AuDaGe is a tool for converting between common process control data formats using Python (pandas). AuDaGe will initially consist of a command-line interface with a GUI application possibly to come later. +## Project Structure +- AuDaGe + - docs + - src + - AuDaGe + - formats + - applications + - assets + - file format modules + - common code modules + - tests + - assets + - output + - test modules + - configuration + ## Planned formats (non-exhaustive): - PLC variable export: - In Development: @@ -11,17 +27,21 @@ with a GUI application possibly to come later. - Planned: - Schneider Electric ControlExpert TSV (TXT) - Allen-Bradley CSV + - Maybe someday: + - Siemens - HMI/SCADA databases: - In Development: - Kepserver EX/Enterprise CSV - Planned: - FactoryTalk View SE Alarm Database XLS and/or XML - - PI Historian XLSX + - PI Historian XLS(X) + - Maybe someday: + - Kepserver OPF/PFE ## Dataframe format -| name | [parent] | type | address | [bitrank] | [save] | comment | -|:----:|:--------:|:----:|:-------:|:---------:|:------:|:-------:| +| name | type | address | comment | +|:----:|:----:|:-------:|:-------:| ## Dependencies - pandas \ No newline at end of file