banesullivan / scooby

🐶 🕵️ Great Dane turned Python environment detective
MIT License
47 stars 12 forks source link

Autogenerate Reports for any package and its dependencies #118

Closed banesullivan closed 11 months ago

banesullivan commented 11 months ago

The CLI that @prisae implemented is awesome!

I found myself wanting to take it a step further. I wanted scooby to generate insightful reports about packages that do not have a Report class implemented directly.

These changes let the CLI fallback to using pkg_resources to get the distribution requirements to autogenerate a report about the specified package and its direct dependencies.

For example, matplotlib

$ scooby -r matplotlib

--------------------------------------------------------------------------------
  Date: Fri Oct 20 00:27:27 2023 PDT

                OS : Darwin
            CPU(s) : 8
           Machine : arm64
      Architecture : 64bit
               RAM : 16.0 GiB
       Environment : Python
       File system : apfs

  Python 3.11.3 | packaged by conda-forge | (main, Apr  6 2023, 08:58:31)
  [Clang 14.0.6 ]

        matplotlib : 3.7.1
         contourpy : 1.0.7
            cycler : 0.11.0
         fonttools : 4.39.4
        kiwisolver : 1.4.4
             numpy : 1.24.3
         packaging : 23.1
            pillow : 9.5.0
         pyparsing : 3.0.9
   python-dateutil : 2.8.2
--------------------------------------------------------------------------------

Other Changes

codecov-commenter commented 11 months ago

Codecov Report

Merging #118 (c9e67c0) into main (a5a34b0) will increase coverage by 1.87%. The diff coverage is 90.69%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main     #118      +/-   ##
==========================================
+ Coverage   85.22%   87.10%   +1.87%     
==========================================
  Files           5        5              
  Lines         440      473      +33     
==========================================
+ Hits          375      412      +37     
+ Misses         65       61       -4     
banesullivan commented 11 months ago

Took this a bit further!