Metadata-Version: 2.1
Name: good_smell
Version: 0.3
Summary: A linter/refactoring tool to make you code smell better!
Home-page: https://github.com/Tadaboody/good_smell
Author: Tomer Keren
Author-email: tomer.keren.dev@gmail.com
License: BSD
Description: # Good Smell - it makes your code smell good! 
        A linting/refactoring library for python best practices and lesser-known tricks  
        ---
        [![Build Status](https://travis-ci.com/Tadaboody/good_smell.svg?branch=master)](https://travis-ci.com/Tadaboody/good_smell) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
        ---
        
        ## Installing:
        Clone the repository and run inside it
        ```sh
        pip install . # add -e for development
        ```
        ## Usage:
        ``
        good_smell warn - Print warnings about smells in the code
        ``
        ```sh
        good_smell warn PATH
        good_smell warn --path PATH
        ```
        Alternativly you can run it through [flake8](http://flake8.pycqa.org/en/latest/). Smells will be with the code SMLxxx  
        
        ``good_smell fix - Print a fixed version of the code``
        ```sh
        good_smell fix PATH [STARTING_LINE] [END_LINE]
        good_smell fix --path PATH [--starting-line STARTING_LINE] [--end-line END_LINE]
        ```
        ## Supported code smells:
        
        ``Range(len(sequence))``
        ```py
        for i in range(len(sequence)):
            x = sequence[i]
            do_thing(x,i)
        ```
        will be fixed to 
        ```py
        for i, x in enumerate(sequence):
            do_thing(x,i)
        ```
        ``Directly nested for loops``
        ```py
        for i in seq_a:
            for j in seq_b:
                print(i, j)
        ```
        to
        ```py
        import itertools
        for i, j in itertools.product(seq_a, seq_b):
            print(i, j)
        ```
        
        ### Running tests
        ```sh
        pip install .[test]
        pytest
        ```
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Flake8
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown
Provides-Extra: test
