Various things - Githubissues

prisae commented 5 years ago

Sorry, this got a bit a mess. Take want you want, feel free to remove things you don't like, we can iterate over it a bit.

Remove investigate; (closes #17) scooby.investigate() and scoopy.Report() were duplicates. We should just have one.
I don't think we should force the version of scooby onto the user. Again, we should be minimalistic. If a user does not want to print scooby, he shouldn't have to.
Bring the additional packages first, the once the end user wants. Then the core packages, the ones a module dev wants. And bring the optional ones at the very end.
I removed GLOBAL_VARIABLES when they were only used once (I personally think global variables are bad; they have their use-case, but if they are only used once, they are not required. IMHO.)
Add some minimal info-text to the __init__.py
Closes #18: OS-info and environment info are now the same for text and html version; also failed packages.
Removed all RUH-ROH. As we discussed earlier. The name is goofy, but all the rest should be serious. For wide adaption.
Addressed what I mentioned in the comment below: Removed _add_package and _add_package_by_name; most of these things were duplicated things done in get_version anyway. It is much simpler now.
Removed all flake8 (flake8 scooby/*.py) complaints (double lines, inline comments starting with #, unused imports; too long lines; etc); typos

prisae commented 5 years ago

I did some stuff in the original scripts for empymod, subsequently changed them for SimPEG, and then for emg3d. Now you did some further changes. I think all that passing around made a mess out of

def _add_package(self, module, name=None, optional=False)
def _add_package_by_name(self, name, optional=False)
def add_packages(self, packages, optional=False)
def get_version(self, pckg)

That should probably be simplified and cleaned up...

=> There are many duplications within these sfunctions.

prisae commented 5 years ago

I also added changes to in_ipykernel, as you had some misleading comments. Of course a notebook IS ALSO IPython, I tried to clarify a few things.

prisae commented 5 years ago

OK, I am done with this PR. Let me know what you think!

banesullivan commented 5 years ago

I think there should be a distinction between version not available and package not available. For example:

>>> scooby.Report(['gdal', 'foo'], )

--------------------------------------------------------------------------------
  Date: Sun Jun 30 10:45:49 2019 MDT

         Darwin : OS
             12 : CPU(s)
         x86_64 : Machine
          64bit : Architecture
        32.0 GB : RAM
         Python : Environment

  Python 3.7.3 | packaged by conda-forge | (default, Mar 27 2019, 15:43:19)
  [Clang 4.0.1 (tags/RELEASE_401/final)]

             NA : gdal
             NA : foo
         1.16.3 : numpy
          1.3.0 : scipy
          7.5.0 : IPython
          3.1.0 : matplotlib
          0.2.2 : scooby

  Intel(R) Math Kernel Library Version 2018.0.3 Product Build 20180406 for
  Intel(R) 64 architecture applications
--------------------------------------------------------------------------------

As a developer receiving that report, I'd like to know that yes gdal is installed even though scooby doesn't know how to get the version but foo is not installed.

Right now they nook the same (not installed) to someone receiving the report when infact gdal is available and foo is not

banesullivan commented 5 years ago

I just fixed https://github.com/banesullivan/scooby/pull/19#issuecomment-507050685 with 00dc525. Thought @prisae?

>>> scooby.Report(['gdal', 'foo'], )

--------------------------------------------------------------------------------
  Date: Sun Jun 30 11:00:06 2019 MDT

         Darwin : OS
             12 : CPU(s)
         x86_64 : Machine
          64bit : Architecture
        32.0 GB : RAM
         Python : Environment

  Python 3.7.3 | packaged by conda-forge | (default, Mar 27 2019, 15:43:19)
  [Clang 4.0.1 (tags/RELEASE_401/final)]

            UNK : gdal
             NA : foo
         1.16.3 : numpy
          1.3.0 : scipy
          7.5.0 : IPython
          3.1.0 : matplotlib
          0.2.2 : scooby

  Intel(R) Math Kernel Library Version 2018.0.3 Product Build 20180406 for
  Intel(R) 64 architecture applications
--------------------------------------------------------------------------------

banesullivan commented 5 years ago

I'm not sure if UNK is the best acronym

prisae commented 5 years ago

What about

Pckg not found
Version unknown

banesullivan commented 5 years ago

I like those - more explicit/clear

banesullivan / scooby

Various things #19