objdictgen 3.3__tar.gz → 3.4__tar.gz

{objdictgen-3.3 → objdictgen-3.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: objdictgen
-Version: 3.3
-Summary: CanFestival object dictionary tools
-Home-page: https://github.com/laerdal-svg/python-objdictgen
+Version: 3.4
+Summary: CanFestival Object Dictionary tool
+Home-page: https://github.com/Laerdal/python-objdictgen
 Author: Svein Seldal
 Author-email: sveinse@seldal.com
-Keywords: build,development,canfestival,canopen,objdictgen
+Keywords: build,development,canopen,canfestival,object dictionary,od
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
@@ -13,21 +13,32 @@ Classifier: Topic :: Software Development :: Code Generators
 Classifier: Topic :: Software Development :: Embedded Systems
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: <4,>=3.10
 Description-Content-Type: text/markdown
-Provides-Extra: dist
-Provides-Extra: lint
-Provides-Extra: test
 License-File: LICENSE
+Requires-Dist: jsonschema
+Requires-Dist: colorama
+Requires-Dist: deepdiff
+Provides-Extra: ui
+Requires-Dist: wxPython; extra == "ui"
+Provides-Extra: dist
+Requires-Dist: build; extra == "dist"
+Provides-Extra: dev
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: types-colorama; extra == "dev"
+Requires-Dist: types-wxpython; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
 
 # Objdictgen (`odg`)
 
@@ -38,13 +49,13 @@ communication protocol.
 
 This repo is located:
 
-> https://github.com/laerdal-svg/python-objdictgen
+> https://github.com/Laerdal/python-objdictgen
 
 objdictgen includes tools to generate c code that works in tandem with a
 canfestival library. This tool has been built to work together with the
 Laerdal Medical fork for the canfestival library:
 
-> https://github.com/laerdal-svg/canfestival-laerdal
+> https://github.com/Laerdal/canfestival-laerdal
 
 objdictgen is a tool to parse, view and manipulate files containing object
 dictionary (OD). An object dictionary is entries with data and configuration
@@ -53,24 +64,6 @@ reading and writing OD files in `.json` format, in legacy XML `.od` and `.eds`
 files. It can generate c code for use with the canfestival library.
 
 
-## Motivation
-
-The biggest improvement with the new tool over the original implementation is
-the introduction of a new `.json` based format to store the object dictionary.
-The JSON format is well-known and easy to read. The tool supports jsonc,
-allowing comments in the json file. `odg` will process the file in a repeatable
-manner, making it possible support diffing of the `.json` file output. `odg`
-remains 100% compatible with the legacy `.od` format on both input and output.
-
-The original objdictedit and objdictgen tool were written in legacy python2 and
-and this is a port to python3. The package still remains compatible with
-python2, as python2 is required for running the UI tools.
-
-This tool is a fork from upstream canfestival-3-asc repo:
-
-> https://github.com/laerdal-svg/canfestival-3-asc
-
-
 ## Install
 
 To install into a virtual environment `venv`. Check out this repo and go to
@@ -78,28 +71,13 @@ the top in a command-prompt (here assuming Windows and git bash):
 
     $ py -3 -mvenv venv
     $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .
+    $ venv/Scripts/pip install .[ui]    # [ui] will install GUI tools
 
-After this `venv/Scripts/odg.exe` will exist and can be called
+After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
 from anywhere to run it.
 
-
-### Python 2
-
-To run the `objdictedit` GUI, wxPython is required and it is only available
-for Python 2.7. Download and install both.
-
-   * https://www.python.org/downloads/release/python-2716/
-   * https://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/
-
-To setup the virtual environment run (assuming git bash):
-
-    $ py.exe -2 -mvirtualenv --system-site-packages venv
-    $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .
-
-NOTE: The `py.exe` tool is only shipped with recent Python 3.
-
+The `[ui]` suffix to `pip install` will install the wx dependency needed
+for the UI `odg edit`. If no UI is needed, this suffix can be omitted.
 
 ## `odg` command-line tool
 
@@ -122,10 +100,8 @@ The most useful commands are:
 
 ### Legacy commands
 
-The legacy commands `objdictgen` and `objdictedit` are still available. The
-same commands are available under `odg gen` and `odg edit` respectively. Note
-that Python 2 is required to run `objdictedit` due to the dependency on the
-old wxpython library.
+The legacy commands `objdictgen` and `objdictedit` are no longer available. The
+commands are available under `odg gen` and `odg edit` respectively.
 
 
 ## JSON schema
@@ -152,7 +128,6 @@ descriptions, help with values and validate the file.
     }
 ```
 
-
 ## Conversion
 
 The recommended way to convert existing/legacy `.od` files to the new JSON
@@ -166,6 +141,23 @@ parameters. The `--drop-unused` will remove any unused *profile* and *DS-302*
 parameter that might be used in the file.
 
 
+## Motivation
+
+The biggest improvement with the new tool over the original implementation is
+the introduction of a new `.json` based format to store the object dictionary.
+The JSON format is well-known and easy to read. The tool supports jsonc,
+allowing comments in the json file. `odg` will process the file in a repeatable
+manner, making it possible support diffing of the `.json` file output. `odg`
+remains 100% compatible with the legacy `.od` format on both input and output.
+
+The original objdictedit and objdictgen tool were written in legacy python 2 and
+and this is a port to python 3.
+
+This tool is a fork from upstream canfestival-3-asc repo:
+
+> https://github.com/Laerdal/canfestival-3-asc
+
+
 ## License
 
 Objdictgen has been based on the python tool included in CanFestival. This
@@ -175,4 +167,4 @@ original work from CanFestival is:
 
 The Python 3 port and tool improvements have been implemented under
 
-    Copyright (C) 2022 Svein Seldal, Laerdal Medical AS
+    Copyright (C) 2022-2024 Svein Seldal, Laerdal Medical AS

{objdictgen-3.3 → objdictgen-3.4}/README.md

@@ -7,13 +7,13 @@ communication protocol.
 
 This repo is located:
 
-> https://github.com/laerdal-svg/python-objdictgen
+> https://github.com/Laerdal/python-objdictgen
 
 objdictgen includes tools to generate c code that works in tandem with a
 canfestival library. This tool has been built to work together with the
 Laerdal Medical fork for the canfestival library:
 
-> https://github.com/laerdal-svg/canfestival-laerdal
+> https://github.com/Laerdal/canfestival-laerdal
 
 objdictgen is a tool to parse, view and manipulate files containing object
 dictionary (OD). An object dictionary is entries with data and configuration
@@ -22,24 +22,6 @@ reading and writing OD files in `.json` format, in legacy XML `.od` and `.eds`
 files. It can generate c code for use with the canfestival library.
 
 
-## Motivation
-
-The biggest improvement with the new tool over the original implementation is
-the introduction of a new `.json` based format to store the object dictionary.
-The JSON format is well-known and easy to read. The tool supports jsonc,
-allowing comments in the json file. `odg` will process the file in a repeatable
-manner, making it possible support diffing of the `.json` file output. `odg`
-remains 100% compatible with the legacy `.od` format on both input and output.
-
-The original objdictedit and objdictgen tool were written in legacy python2 and
-and this is a port to python3. The package still remains compatible with
-python2, as python2 is required for running the UI tools.
-
-This tool is a fork from upstream canfestival-3-asc repo:
-
-> https://github.com/laerdal-svg/canfestival-3-asc
-
-
 ## Install
 
 To install into a virtual environment `venv`. Check out this repo and go to
@@ -47,28 +29,13 @@ the top in a command-prompt (here assuming Windows and git bash):
 
     $ py -3 -mvenv venv
     $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .
+    $ venv/Scripts/pip install .[ui]    # [ui] will install GUI tools
 
-After this `venv/Scripts/odg.exe` will exist and can be called
+After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
 from anywhere to run it.
 
-
-### Python 2
-
-To run the `objdictedit` GUI, wxPython is required and it is only available
-for Python 2.7. Download and install both.
-
-   * https://www.python.org/downloads/release/python-2716/
-   * https://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/
-
-To setup the virtual environment run (assuming git bash):
-
-    $ py.exe -2 -mvirtualenv --system-site-packages venv
-    $ venv/Scripts/python -mpip install --upgrade pip wheel setuptools
-    $ venv/Scripts/pip install .
-
-NOTE: The `py.exe` tool is only shipped with recent Python 3.
-
+The `[ui]` suffix to `pip install` will install the wx dependency needed
+for the UI `odg edit`. If no UI is needed, this suffix can be omitted.
 
 ## `odg` command-line tool
 
@@ -91,10 +58,8 @@ The most useful commands are:
 
 ### Legacy commands
 
-The legacy commands `objdictgen` and `objdictedit` are still available. The
-same commands are available under `odg gen` and `odg edit` respectively. Note
-that Python 2 is required to run `objdictedit` due to the dependency on the
-old wxpython library.
+The legacy commands `objdictgen` and `objdictedit` are no longer available. The
+commands are available under `odg gen` and `odg edit` respectively.
 
 
 ## JSON schema
@@ -121,7 +86,6 @@ descriptions, help with values and validate the file.
     }
 ```
 
-
 ## Conversion
 
 The recommended way to convert existing/legacy `.od` files to the new JSON
@@ -135,6 +99,23 @@ parameters. The `--drop-unused` will remove any unused *profile* and *DS-302*
 parameter that might be used in the file.
 
 
+## Motivation
+
+The biggest improvement with the new tool over the original implementation is
+the introduction of a new `.json` based format to store the object dictionary.
+The JSON format is well-known and easy to read. The tool supports jsonc,
+allowing comments in the json file. `odg` will process the file in a repeatable
+manner, making it possible support diffing of the `.json` file output. `odg`
+remains 100% compatible with the legacy `.od` format on both input and output.
+
+The original objdictedit and objdictgen tool were written in legacy python 2 and
+and this is a port to python 3.
+
+This tool is a fork from upstream canfestival-3-asc repo:
+
+> https://github.com/Laerdal/canfestival-3-asc
+
+
 ## License
 
 Objdictgen has been based on the python tool included in CanFestival. This
@@ -144,4 +125,4 @@ original work from CanFestival is:
 
 The Python 3 port and tool improvements have been implemented under
 
-    Copyright (C) 2022 Svein Seldal, Laerdal Medical AS
+    Copyright (C) 2022-2024 Svein Seldal, Laerdal Medical AS