graphkit icon indicating copy to clipboard operation
graphkit copied to clipboard

ENH: Preparations for releasing v1.3.0

Open ankostis opened this issue 5 years ago • 12 comments

Preparations for baking a new release & last-days fixes.

  • enh(TCs): Doctest all code; enabled many assertions that were just print-outs in v1.2.4.
  • FIX(ops): operation.__repr__() was crashing when not all arguments had been set - a condition frequtnly met during debugging session.
  • enh(net): Annotate operation exceptions with ExecutionPlan to aid debug sessions, inspired by @syamajala's 309338340.
  • doc: add CHANGES.rst changelog, with flowcharts comparing versions 1.2.4 <-->1.3..0.
  • doc: add API reference chapter.
  • enh: build, site & documentation for all new features.
  • drop(build): sphinx_rtd_theme is the default for sphinx now.

GraphkitFlowchart-v1 3 0


I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

ankostis avatar Oct 09 '19 16:10 ankostis

Codecov Report

Merging #30 into master will increase coverage by 14.07%. The diff coverage is 92.9%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master      #30       +/-   ##
===========================================
+ Coverage   77.87%   91.94%   +14.07%     
===========================================
  Files           5        6        +1     
  Lines         348      534      +186     
===========================================
+ Hits          271      491      +220     
+ Misses         77       43       -34
Impacted Files Coverage Δ
graphkit/modifiers.py 100% <100%> (ø) :arrow_up:
graphkit/__init__.py 100% <100%> (ø) :arrow_up:
graphkit/plot.py 89.14% <89.14%> (ø)
graphkit/base.py 82.92% <89.74%> (+3.56%) :arrow_up:
graphkit/functional.py 95.4% <95.12%> (+1.65%) :arrow_up:
graphkit/network.py 94.93% <95.13%> (+24.72%) :arrow_up:

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 e70718b...7bd3f85. Read the comment docs.

codecov-io avatar Oct 09 '19 16:10 codecov-io

@huyng @robwhess @pumpikano would you consider to publish a new release here, in PyPi & generated documentation, based on the changes i crafted the last 2 weeks, describe in the CHANGES?

Finally, offering my self to become a contributor to this repo & in PyPi, and do the release my self, if you don't have any issues with this.

ankostis avatar Oct 09 '19 20:10 ankostis

@ankostis I'm not at Yahoo anymore and don't have the time or desire to maintain this project. Since I'm not at Yahoo, I don't have any authority to make you a collaborator on this repo (I don't even have authority to approve your PR), but I'm happy to make you an owner of this project on PyPI. What's your username? In the worst case, you could use PyPI permission to start publishing GraphKit from your own fork.

Any Yahoos listening who can add @ankostis as a collaborator here (@pierreg??)?

@huyng @pumpikano How's it going? I hope all's well.

robwhess avatar Oct 09 '19 21:10 robwhess

Thank you for your time (i know how it feels to be bothered back-from-the-grave). Please, proceed, I have the same username in PyPi.

Bu i would really appreciate if we can keep this repo as a central piece of information. Otherwise, i would make a new organization,fork in there and clone issues (a bit of nuance), to keep history & references working.

ankostis avatar Oct 09 '19 21:10 ankostis

@ankostis done.

robwhess avatar Oct 09 '19 21:10 robwhess

Thank you Rob :+1: I will wait a coupleof days before publishing, to get access, or else i would have to change URLs, etc

ankostis avatar Oct 09 '19 21:10 ankostis

Regarding backward compatibilkity, GitHub shows only 1 project depending on this library, most likely a bundle of utilities, not actually making use of graphkit API.

@huyng @pumpikano could we have an idea whether this library is used by your private projects that might break if the version published in PyPi has a different behavior, or has a refactored internal API?

ankostis avatar Oct 10 '19 13:10 ankostis

Hi @ankostis, I appreciate your interest in this — this was heavily used internally at Yahoo and I believe it is still a very useful. I am in the same boat as @robwhess (hey, Rob :) ) and I think none of the original authors work at Yahoo anymore. @jackculpepper, do you want to weigh in here? Maybe there is a way to give @ankostis ownership of this repo?

@ankostis, I would say that, unless @jackculpepper has some alternative, you should fork this however/wherever you like and make all the executive decisions. Perhaps leave an issue and PR pointing the way to your new repo.

In regards to pushing to PyPi, if you have the keys now I think you should also feel free to make these decisions. If you break behaviors, then I'd suggest bumping the version to 2.0 and taking things from there.

pumpikano avatar Oct 10 '19 15:10 pumpikano

@ankostis Thanks for the PR. We're no longer at Yahoo. Sorry for the delayed response. I've been on a bit of a vacation / coding hiatus. If you make your PR to https://github.com/huyng/graphkit, I can give this a review today and release this week.

Thanks

huyng avatar Oct 10 '19 15:10 huyng

PR huyng/graphkit#1 Done.

ankostis avatar Oct 10 '19 16:10 ankostis

Dear Huy, If you the original GH-repo is salvagable, i suggest the do any discussion eithetr on that repo, or on the commits themselves, so as not to proliferate information to multiple repos.

ankostis avatar Oct 10 '19 16:10 ankostis

This is considered done.

Review moved to #31. Will close with 1.3.0

ankostis avatar Oct 11 '19 15:10 ankostis