Python Package

[jayqi]

This is an initial PR from my fork into an uptake:py-pkg branch, with a generally working implementation of pkgnet in Python.

I deliberately have not moved any of the existing files related to the R package to avoid unnecessary diffs. We can move everything once we're ready to merge the Python package into master.

Some salient points:

• Reporters:
  • The following equivalents of R package reporters exist: SummaryReporter, DependencyReporter, FunctionReporter, InheritanceReporter. Note that the implementations may not be 100% correct or complete, e.g., FunctionReporter is not handling all types of functions yet, such as methods on objects.
  • Two new reporters ModuleReporter and ImportReporter were added.
• The graph backend uses networkx.
• I implemented and tried out a few javascript network visualization libraries: vis.js, sigma.js, and cytoscape.js. Probably the vis.js implementation is best so far, but still needs a lot of finagling.
  • Node coloring and other visualization customization is not implemented yet.
• The package report is rendered using jinja2. All Javascript dependencies are currently loaded using CDN. I tried inline injection and wasn't able to get it working.
• The interfaces between reporters and jinja2 template are a little fuzzy right now, since htmlwidgets as a general interface don't exist in Python. Support for Jupyter Notebooks may factor into how we think about these interfaces.

[codecov-io]

Codecov Report

Merging #268 into py-pkg will not change coverage by %. The diff coverage is n/a.

@@           Coverage Diff           @@
##           py-pkg     #268   +/-   ##
=======================================
  Coverage   92.46%   92.46%           
=======================================
  Files          12       12           
  Lines         929      929           
=======================================
  Hits          859      859           
  Misses         70       70           

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9fe580d...307dfae. Read the comment docs.

[jayqi]

@jameslamb @bburns632 did some work on things this week and I think it's ready for another look.

do you propose that we eventually have only one JS backend and hide the details of it from users? Or do you think it's possible we'll keep multiple and allow people to pick between them with a new keyword argument to create_package_report()?

I had ambitiously been imagining the latter, but maybe that's too ambitious. I'm open to either.

Could you add a smoke test that minimally tests create_package_report() with all the reporters on something that is likely to already be installed, like requests?

I've added a README. I think running on jinja2 is simplest package that works quickly and reliably. Instructions are in the readme.

[jayqi]

Alright, since you approved and this is going into a separate branch anyways, I'm going to merge this and start tackling tests and other stuff in new PRs.