Changeset 161

Show
Ignore:
Timestamp:
01/31/07 07:14:04 (2 years ago)
Author:
mk
Message:

Mentioned PEP8 in README.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/README

    r158 r161  
    246246  * package has high pylint score: 50 
    247247  * package has unit tests: 30 
     248  * package doesn't follow PEP8 conventions [#PEP8]_: -2 for each error type and -1 for each warning type 
    248249 
    249250The final score depends on how well the package scores for all indexes 
    …… 
    260261   recognized. We give 10 points for 25% of formatted docstrings, 20 points 
    261262   for 50% and 30 points for 75%. 
     263.. [#PEP8] PEP8 defines a good coding style for Python, see 
     264   `PEP8 document <http://www.python.org/dev/peps/pep-0008/>`_ for details. 
    262265 
    263266Sample output 
    …… 
    266269:: 
    267270 
    268     $ python cheesecake_index -n Durus 
    269     py_pi_download .........................  50  (downloaded package Durus-3.4.1.tar.gz following 1 link from http://www.mems-exchange.org/software/durus/Durus-3.4.1.tar.gz) 
     271    $ python cheesecake_index -n nose 
     272    py_pi_download .........................  50  (downloaded package nose-0.9.1.tar.gz following 1 link from http://somethingaboutorange.com/mrl/projects/nose/nose-0.9.1.tar.gz) 
    270273    unpack .................................  25  (package unpacked successfully) 
    271     unpack_dir .............................  15  (unpack directory is Durus-3.4.1 as expected) 
     274    unpack_dir .............................  15  (unpack directory is nose-0.9.1 as expected) 
    272275    setup.py ...............................  25  (setup.py found) 
    273     install ................................  50  (package installed in /tmp/cheesecakeUrZH1A/tmp_install_Durus-3.4.1) 
     276    install ................................  50  (package installed in /tmp/cheesecakeOzL_mb/tmp_install_nose-0.9.1) 
    274277    generated_files ........................   0  (0 .pyc and 0 .pyo files found) 
    275278    --------------------------------------------- 
    …… 
    277280    INSTALLABILITY INDEX (RELATIVE) ........ 100  (165 out of a maximum of 165 points is 100%) 
    278281 
    279     required_files ......................... 170  (5 files and 2 required directories found) 
    280     docstrings .............................  33  (found 121/369=32.79% objects with docstrings) 
    281     formatted_docstrings ...................   0  (found 6/369=1.63% objects with formatted docstrings) 
     282    required_files ......................... 110  (4 files and 2 required directories found) 
     283    docstrings .............................  43  (found 139/329=42.25% objects with docstrings) 
     284    formatted_docstrings ...................   0  (found 53/329=16.11% objects with formatted docstrings) 
    282285    --------------------------------------------- 
    283     DOCUMENTATION INDEX (ABSOLUTE) ......... 203 
    284     DOCUMENTATION INDEX (RELATIVE) .........  58  (203 out of a maximum of 350 points is 58%) 
    285  
    286     pylint .................................  33  (pylint score was 6.59 out of 10) 
    287     unit_tested ............................  30  (have unit tests) 
     286    DOCUMENTATION INDEX (ABSOLUTE) ......... 153 
     287    DOCUMENTATION INDEX (RELATIVE) .........  44  (153 out of a maximum of 350 points is 44%) 
     288 
     289    unit_tested ............................  30  (has unit tests) 
     290    pylint .................................  37  (pylint score was 7.29 out of 10) 
     291    pep8 ................................... -16  (pep8.py check: 7 error types, 2 warning types) 
    288292    --------------------------------------------- 
    289     CODE KWALITEE INDEX (ABSOLUTE) .........  63 
    290     CODE KWALITEE INDEX (RELATIVE) .........  79  (63 out of a maximum of 80 points is 79%) 
     293    CODE KWALITEE INDEX (ABSOLUTE) .........  51 
     294    CODE KWALITEE INDEX (RELATIVE) .........  64  (51 out of a maximum of 80 points is 64%) 
    291295 
    292296 
    293297    ============================================= 
    294     OVERALL CHEESECAKE INDEX (ABSOLUTE) .... 431 
    295     OVERALL CHEESECAKE INDEX (RELATIVE) ....  72  (431 out of a maximum of 595 points is 72%) 
     298    OVERALL CHEESECAKE INDEX (ABSOLUTE) .... 369 
     299    OVERALL CHEESECAKE INDEX (RELATIVE) ....  62  (369 out of a maximum of 595 points is 62%) 
    296300 
    297301Case study: Cleaning up PyBlosxom 
    …… 
    312316by the Cheesecake metrics. 
    313317 
    314 .. footer:: Last modified 2006-02-12 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_. 
     318.. footer:: Last modified: 31 Jan 2007 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_.