Metadata-Version: 2.1
Name: pyclang
Version: 0.1.1
Summary: A python clang-tidy runner
Home-page: UNKNOWN
Author: Fu Hanxi
Author-email: fuhanxi@espressif.com
License: MIT
Description: # Clang Tidy Runner
        
        ## Installation
        
        Please install it via `pip install pyclang`.
        
        [![pyclang](https://img.shields.io/pypi/v/pyclang?color=green&label=pyclang)](https://pypi.org/project/pyclang/)
        
        ## Examples
        
        ```python
        import os
        
        from pyclang import Runner
        
        # all the dirs you want to run clang-tidy in, will use this value to pass to all chained methods automatically
        runner = Runner([os.path.join(os.environ['IDF_PATH'], 'examples', 'get-started', 'hello_world')])
        runner.idf_reconfigure().normalize()  # each function is a step, all these steps are chainable
        runner()  # the class instance is callable, call it to run all the chained methods
        ```
        
        You can write custom chain method by using decorator `@chain`.
        
        Restrictions: all arguments are fixed, you need to pass the rest of them when initializing `Runner` instance with kwargs
        
        - `folder`: which is the folder you passed when initializing `Runner` instance
        - `log_fs`: file stream (if you provided `log_path`) or `sys.stdout`
        
        ```python
        import os
        
        from pyclang import Runner
        
        
        class CustomRunner(Runner):
            @chain
            def hello(self, *args):
                print('hello world')
        
        
        # and used by
        runner = Runner([os.path.join(os.environ['IDF_PATH'], 'examples', 'get-started', 'hello_world')])
        runner.hello().idf_reconfigure()
        runner()
        ```
        
        ## CLI Extension
        
        For each custom chain method, you should also define this in `cli_ext.py` if there're additional arguments.
        
        ## Use as a script
        
        You can also customize it into a scripts. Now we provide a predefined script: `idf_clang`, which procedure
        is: `idf_reconfigure().filter_cmd().run_clang_tidy().normalize()`. You can run it by `idf_clang --help` for detail.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
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 :: Only
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: make_html_report
