Metadata-Version: 2.1
Name: techdebt
Version: 0.1.2
Summary: A technical debt tracker package
Home-page: https://github.com/lcetinsoy/tech-debt
Author: Laurent Cetinsoy
Author-email: laurent.cetinsoy@gmail.com
License: UNKNOWN
Description: # Tech-debt
        
        A simple tool to quantify your technical debt
        
        ## Installation  
        
        requirements : python 3 
        
        ```bash
        pip install techdebt
        ```
        
        ## Usage 
        
        
        1. Adding debpt annotation
        
        add debt annotations in your project files to mark technical debt:
        
        - @debt() 
        - @debt("debt_type") or 
        - @debt("debt_type":"comment")
          
        
        Let's say you have a python file with some debt : 
        
        ```python
        #@debt("implementation")
        def poor_function():
            
            #@debt("implementation": "variable naming")
            bla = 2
            return bla
        ```
        
        2. Project configuration
        
        Adapt the following configuration file and put 
        it in your project folder (cf config_example.yml)
         
        ```yaml
        
        folder:
          included:
            - test_project/subA
            - test_project/subB
        
          excluded:
            - vendor
            - node_modules
            - var
            - web
            - nbproject
            - public
            - .git
            - __pycache__
        
        extensions:
          - .py
          - .js
          - .md
          - .php
        
        scores:
          api: 5
          implementation: 3
        
        ```
        
        3. Run
        
        ```bash
        techdebt --conf="path/to/config_file.yml" #default is "techdebt.yml"
        ```
        
        
        ## Plugins 
        
        You may want to have automatic code checkers do 
        some analysis and being included in the final debt score
        
        For now phpstan is the sole plugin available
        
        edit configuration with the following: 
        
        ```yaml
        
        plugin:
            phpstan:
                function_to_call: ""
                folders: 
                    - folder_to_analyse
                scores: 
                    - 
        
        ```
        
        ## adding plugin
        
        
        you need to code a file plugin with a method which
        returns scores and then add it to the yarml file
        
        
        ## Roadmap 
        
        - adding line file of annotation
        - better reporting
        - tracking debt over time
        - adding estimation range
        
        
        
        ## Testing 
        
        ```bash 
        pytest -s src/lib.py
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
