Metadata-Version: 1.0
Name: tangoname
Version: 2.1.9
Summary: A script that generates json2tango configuration files
Home-page: http://www.maxiv.lu.se
Author: Emil Rosendahl
Author-email: emil.rosendahl@maxiv.lu.se
License: GPLv3
Description: _Are you looking for the "long" tag name convention tool? Check the
        `legacy-pre-june-2018` branch._
        
        # MAX IV Control System Tango Configuration script
        
        ## Description
        
        A tool to produce `json2tango` / `dsconfig` complient JSON files from a PLC taglist.
        
        The rules are specified in the [Object Tag Definition](https://alfresco.maxiv.lu.se/share/page/site/maxiv/document-details?nodeRef=workspace://SpacesStore/2adb9866-5dba-4ba8-9db7-530246f1a956)
        
        ## Use Case
        
        ### List supported devices
        
        ```shell
        python -m tangoname devices
        ```
        
        ### Generate a config file
        
        ```shell
        python3 -m tangoname generate <plc-host-name> <plc-taglist-csv-file> <list-of-devices>
        ```
        
        **Example (and redirect to file)**
        
        ```shell
        python3 -m tangoname generate b316a-cab-plc-01 ~/B316A_A101630_CAB01_VAC_PLC01.csv acp,vac,tur,watp > config.json
        ```
        
        Errors will still be printed but the regular output will be put in the file.
        
        
        
        ## Run Test
        
        Run the tests with pytest.
        
        ```shell
        python3 -m pytest --capture=no --cov=tangoname --verbose
        ```
        
        Run specific test function:
        
        ```shell
        python3 -m pytest --capture=no tests/test_file.py::test_specific_function
        ```
        
Platform: UNKNOWN
