Anselmoo · Anselmoo · Jan 14, 2023 · Jan 14, 2023
@@ -28,7 +28,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10"]
         os: [ubuntu-latest, windows-latest, macOS-latest]
         arch: [x64]
     defaults:

@@ -47,8 +47,9 @@ repos:
             types-PyYAML==6.0.11,
             types-tabulate==0.8.11,
             types-mock==4.0.15,
-            numpy>=1.21.4,
-            pydantic==1.10.3,
+            numpy==1.23.4,
+            pydantic==1.10.1,
+            pytest==6.2.5,
           ]
   - repo: https://github.com/pycqa/pydocstyle
     rev: 6.2.3 # pick a git hash / tag to point to

@@ -156,6 +156,19 @@ available plugins are:
 
     ![Docker-Image](https://github.com/Anselmoo/spectrafit/blob/9094da4472db889d50652d4ded870d42dd0ed559/docs/images/docker.png?raw=true)
 
+    To include the _home directory_ of the host system, the following command can
+    be used:
+
+    ```terminal
+    docker run -it -p 8888:8888 -v $HOME:/home/user/work spectrafit:latest
+    ```
+
+    or via:
+
+    ```terminal
+    docker run -it -p 8888:8888 -v $HOME:/home/user/work ghcr.io/anselmoo/spectrafit:latest
+    ```
+
 [1]: https://github.com/pypa/pipx
 [2]: https://conda.io/docs/
 [3]: https://anaconda.org/conda-forge/spectrafit

@@ -7,8 +7,11 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.12.x  | :white_check_mark: |
-| 0.11.x  | :white_check_mark: |
+| 0.15.x  | :white_check_mark: |
+| 0.14.x  | :x:                |
+| 0.13.x  | :x:                |
+| 0.12.x  | :x:                |
+| 0.11.x  | :x:                |
 | 0.10.x  | :x:                |
 | 0.9.x   | :x:                |
 | 0.8.x   | :x:                |

@@ -24,8 +24,26 @@
 
 ::: spectrafit.plugins.data_converter
 
+### Pkl Converter for pickle files
+
+::: spectrafit.plugins.pkl_converter
+
+!!! info "About [pickle file][6] and the PklVisualizer"
+
+    In addition to exploring the nested structure of the Python's
+    [pickle file][6], the `PklVisualizer` provides two methods to visualize
+    the data:
+
+    1. As graph via [`networkx`][7] and [`matplotlib`][8]
+    2. As json file with  used types
+
+::: spectrafit.plugins.pkl_visualizer
+
 [1]: https://docs.python.org/3/tutorial/datastructures.html#dictionaries
 [2]: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
 [3]: https://docs.python.org/3/library/abc.html#abc.ABC
 [4]: https://docs.python.org/3/library/abc.html#abc.abstractmethod
 [5]: https://pydantic-docs.helpmanual.io/
+[6]: https://docs.python.org/3/library/pickle.html
+[7]: https://networkx.org
+[8]: https://matplotlib.org
@@ -7,17 +7,19 @@ With the command `spectrafit-data-converter` data files can be converted to
 
 ```shell
 ➜ spectrafit-data-converter -f ATHENA -h
-usage: spectrafit-data-converter [-h] [-f {TXT,ATHENA}] infile
+  usage: spectrafit-data-converter [-h] [-f {ATHENA,TXT}] [-e {txt,csv,out,dat}] infile
 
-Converter for 'SpectraFit' from data files to CSV files.
+  Converter for 'SpectraFit' from data files to CSV files.
 
-positional arguments:
-  infile                Filename of the data file to convert.
+  positional arguments:
+    infile                Filename of the data file to convert.
 
-options:
-  -h, --help            show this help message and exit
-  -f {TXT,ATHENA}, --file-format {TXT,ATHENA}
-                        File format for the conversion.
+  options:
+    -h, --help            show this help message and exit
+    -f {ATHENA,TXT}, --file-format {ATHENA,TXT}
+                          File format for the conversion.
+    -e {txt,csv,out,dat}, --export-format {txt,csv,out,dat}
+                          File format for the export.
 ```
 
 !!! example "From ATHENA to CSV"

@@ -6,7 +6,7 @@ With the command `spectrafit-file-converter` input and also output files can be
 
 ```shell
    ➜  spectrafit-file-converter -h
-   usage: spectrafit-file-converter [-h] [-f {lock,toml,yml,yaml,json}] infile
+   usage: spectrafit-file-converter [-h] [-f {yml,lock,yaml,json,toml}] [-e {yml,lock,yaml,json,toml}] infile
 
    Converter for 'SpectraFit' input and output files.
 
@@ -15,9 +15,10 @@ With the command `spectrafit-file-converter` input and also output files can be
 
    options:
      -h, --help            show this help message and exit
-     -f {lock,toml,yml,yaml,json}, --format {lock,ymltoml,yaml,json}
+     -f {yml,lock,yaml,json,toml}, --file-format {yml,lock,yaml,json,toml}
                            File format for the conversion.
-
+     -e {yml,lock,yaml,json,toml}, --export-format {yml,lock,yaml,json,toml}
+                           File format for the export.
 ```
 
 === "File Change from `json` to `lock`"