Metadata-Version: 2.1
Name: pycodeanalyzer
Version: 0.0.4
Summary: Code analyzer to get information to help developers to understand how projects works.
Home-page: https://github.com/miong/pycodeanalyzer
Author: Giovanni Mion
Author-email: mion.ggb@gmail.com
License: MIT
Description: pycodeanalyzer
        ==============
        .. image:: https://img.shields.io/badge/status-active-green
            :alt: Status - active
        .. image:: https://img.shields.io/pypi/pyversions/pycodeanalyzer
            :target: https://pypi.python.org/pypi/pycodeanalyzer
            :alt: Python version
        .. image:: https://img.shields.io/pypi/l/pycodeanalyzer
            :target: https://raw.githubusercontent.com/miong/pycodeanalyzer/main/LICENSE
            :alt: License
        .. image:: https://img.shields.io/pypi/v/pycodeanalyzer.svg
            :target: https://pypi.python.org/pypi/pycodeanalyzer
            :alt: Latest PyPI version
        .. image:: https://img.shields.io/badge/TestPyPi-Latest-blue
           :target: https://test.pypi.org/project/pycodeanalyzer/
           :alt: TestPyPI
        .. image:: https://github.com/miong/pycodeanalyzer/actions/workflows/unittests.yml/badge.svg
            :alt: Unit tests
        .. image:: https://github.com/miong/pycodeanalyzer/actions/workflows/quality.yml/badge.svg
            :alt: Code Quality
        .. image:: https://readthedocs.org/projects/pycodeanalyzer/badge/?version=latest
            :target: https://pycodeanalyzer.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        Code analyzer to get information to help developers to understand how projects works.
        
        Installation
        ------------
        
        pycodeanlyzer is available on PyPI::
        
                pip install pycodeanalyzer
        
        see https://pip.pypa.io/en/stable/installation/ for more detail on pip
        
        see https://test.pypi.org/search/?q=pycodeanalyzer to see the last release candidate
        
                pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple -U pycodeanalyzer
        
        Macos
        ^^^^^
        
        On MacOS, you will need to install libmagic::
        
            brew install libmagic
        
        This is not needed for other platforms.
        
        Requirements
        ^^^^^^^^^^^^
        
        - .. image:: https://img.shields.io/static/v1?label=robotpy-cppheaderparser&message=equals%205.0.16&color=blue
            :alt: - robotpy-cppheaderparser - equals 5.0.16
        - .. image:: https://img.shields.io/static/v1?label=Flask&message=equals%202.0.3&color=blue
            :alt: - Flask - equals 2.0.3
        - .. image:: https://img.shields.io/static/v1?label=Flask-SocketIO&message=equals%205.1.1&color=blue
            :alt: - Flask-SocketIO - equals 5.1.1
        - .. image:: https://img.shields.io/static/v1?label=Flask-Classful&message=equals%200.14.2&color=blue
            :alt: - Flask-Classful - equals 0.14.2
        - .. image:: https://img.shields.io/static/v1?label=flaskwebgui&message=equals%200.3.4&color=blue
            :alt: - flaskwebgui - equals 0.3.4
        - .. image:: https://img.shields.io/static/v1?label=simple-websocket&message=equals%200.5.1&color=blue
            :alt: - simple-websocket - equals 0.5.1
        - .. image:: https://img.shields.io/static/v1?label=injector&message=equals%200.19.0&color=blue
            :alt: - injector - equals 0.19.0
        - .. image:: https://img.shields.io/static/v1?label=pathlib&message=equals%201.0.1&color=blue
            :alt: - pathlib - equals 1.0.1
        - .. image:: https://img.shields.io/static/v1?label=pcpp&message=equals%201.30&color=blue
            :alt: - pcpp - equals 1.30
        - .. image:: https://img.shields.io/static/v1?label=astroid&message=equals%202.11.0&color=blue
            :alt: - astroid - equals 2.11.0
        - .. image:: https://img.shields.io/static/v1?label=javalang&message=equals%200.13.0&color=blue
            :alt: - javalang - equals 0.13.0
        - .. image:: https://img.shields.io/static/v1?label=kopyt&message=equals%200.0.2&color=blue
            :alt: - kopyt - equals 0.0.2
        - .. image:: https://img.shields.io/static/v1?label=simplejson&message=equals%203.17.6&color=blue
            :alt: - simplejson - equals 3.17.6
        - .. image:: https://img.shields.io/static/v1?label=jsonpickle&message=equals%202.1.0&color=blue
            :alt: - jsonpickle - equals 2.1.0
        
        Usage
        -----
        The following is the help of pycodeanalyzer::
        
        	usage: pycodeanalyzer [-h] [--config CONFIGFILE] [--create-config TEMPLATEFILE] [--log LOGLEVEL] [--exportDiagrams EXPORTPATH] [--dumpobj] [--no-ui] [path [path ...]]
        	
        	positional arguments:
        	  path                  Path of a root directory to be analysed
        	
        	optional arguments:
        	  -h, --help            show this help message and exit
        	  --config CONFIGFILE   Configuration file to be used
        	  --create-config TEMPLATEFILE
        	                        Create a configuration file template. Should be used alone.
        	  --log LOGLEVEL        Log level to be used
        	  --exportDiagrams EXPORTPATH
        	                        Export all class diagrams to the path specified
        	  --dumpobj             Serialize objets found, mainly for test purpose
        	  --no-ui               Discard UI, mainly for test purpose
        
        To get more information during the run, use --log=DEBUG
        
        You can see the official documentation here : http://pycodeanalyzer.readthedocs.io/
        
        Languages
        ---------
        
        pycodeanalyser supports the following languages:
        
        - C/C++ (using headers)
        - Python3 (using annotation)
        
        Licence
        -------
        
        This project is under the MIT license::
        
            The MIT License (MIT)
        
            Copyright (c) 2022 Giovanni Mion
        
            Permission is hereby granted, free of charge, to any person obtaining a copy
            of this software and associated documentation files (the "Software"), to deal
            in the Software without restriction, including without limitation the rights
            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
            copies of the Software, and to permit persons to whom the Software is
            furnished to do so, subject to the following conditions:
        
            The above copyright notice and this permission notice shall be included in all
            copies or substantial portions of the Software.
        
            THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
            IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
            FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
            AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
            LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
            OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
            SOFTWARE.
        
        Authors
        -------
        
        `pycodeanalyzer` was written by `Giovanni Mion <mion.ggb@gmail.com>`_.
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Provides-Extra: dev
