Added the function for downloading the badges locally and replace the url with downlaod path #4250

Abelarm · 2020-10-20T10:56:35Z

Issue ref: #3905

Added a function to setup.py for downloading the badge locally and replacing the url with the local path.

Before submitting

Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing, instead of bundling different changes together? Otherwise, we ask you to create a separate PR for every change.
Did you make sure to update the documentation with your changes?
Did you write any new necessary tests?
Did you verify new and existing tests pass locally with your changes?
If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

SURE!

pep8speaks · 2020-10-20T10:56:38Z

Hello @Abelarm! Thanks for updating this PR.

In the file pytorch_lightning/setup_tools.py:

Line 68:121: E501 line too long (145 > 120 characters)

Comment last updated at 2020-12-01 21:07:29 UTC

Abelarm · 2020-10-20T11:07:43Z

I have no idea how to fix the issue with CodeFactor :(

I can't use Requests how suggested by CodeFactor since is the setup and no external should be used (at least I think)

codecov · 2020-10-20T11:28:17Z

Codecov Report

Merging #4250 (58d246a) into master (e952dee) will decrease coverage by 0%.
The diff coverage is 91%.

@@          Coverage Diff           @@
##           master   #4250   +/-   ##
======================================
- Coverage      93%     93%   -0%     
======================================
  Files         123     124    +1     
  Lines        9255    9320   +65     
======================================
+ Hits         8581    8640   +59     
- Misses        674     680    +6

tchaton

Great addition for the doc. Would you mind testing those 2 functions ?

setup.py

tchaton · 2020-10-20T13:31:52Z

setup.py

    return reqs


+def _parse_README_for_badge(text):


Any chance you could add tests for those functions ?

@tchaton I am having a problem:

I wanted to create a test for the two functions, but since they are inside the setup.py file when i try to import them it runs the setup itself, and in this way it crash...how do you think I should proceed?

Move the two functions outside the setup, but where?

Modifying setup in someway that prevents its run when function from it are imported?

ydcjeff · 2020-10-20T13:56:51Z

Not sure this will work on pypi page, but we can get .png from shields.io by replacing img with raster
See: https://raster.shields.io/pypi/pyversions/pytorch-lightning

setup.py

Abelarm · 2020-10-20T14:46:33Z

Not sure this will work on pypi page, but we can get .png from shields.io by replacing img with raster
See: https://raster.shields.io/pypi/pyversions/pytorch-lightning

that's exactly what my script tries to do, first it asks for the .png version by adding the file format (eg. .png) at the end of the url, if the page responds with a valid png then it save it otherwise it downloads the .svg version.
But it always try to download the png version first

stale · 2020-11-04T23:45:12Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://pytorch-lightning.readthedocs.io/en/latest/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Slack. Thank you for your contributions.

Borda · 2020-11-30T18:00:11Z

@tchaton @SeanNaren can you chek, it shall be fine...

Borda · 2020-11-30T19:52:08Z

@Abelarm thinking if we can add simple doctests to for the parsing, just add synthetic sample code and or just a line from readme and see what it return...

Abelarm · 2020-12-01T10:10:18Z

@Abelarm thinking if we can add simple doctests to for the parsing, just add synthetic sample code and or just a line from readme and see what it return...

OK I'll work on it.

Abelarm · 2020-12-01T19:19:58Z

Hi @Borda, I'm seeing a lot fo commits, is there something I can help you with?

Borda · 2020-12-01T19:48:56Z

Hi @Borda, I'm seeing a lot fo commits, is there something I can help you with?

just finalizing and catching some last issues... like Win has problems with re.sub(...) expresion

Borda · 2020-12-01T21:01:14Z

one more todo would be better determining the badge type, eg in the list of badge names also assign what is the type, if SVG or PNG...

… url with downlaod path (#4250) * Added the function for downloading the badge locally, replacing the url * Fixed the pep8 errors, pointed out during pull request * Update setup.py * refactor * format * test * Added Doctest on the functions * test * test * fix * format * fix * fix * prune * fiix * fiix * flake8 * fix * imports * imports * imports * fixx * impoets * win * min Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Jirka Borovec <[email protected]>

Borda · 2020-12-02T23:13:42Z

@Abelarm it seems that it did not work for PyPI page
see our today's RC - https://pypi.org/project/pytorch-lightning/1.1.0rc1
when I open the PKG-INFO I still see the original paths...

Abelarm · 2020-12-09T11:04:43Z

@Abelarm it seems that it did not work for PyPI page
see our today's RC - https://pypi.org/project/pytorch-lightning/1.1.0rc1
when I open the PKG-INFO I still see the original paths...

Hi Borda,

sorry was out for vacation.
I can see that you already solve it. Is there anything else I can do to help you regarding this?

Best, Luigi

Borda · 2020-12-09T13:59:47Z

well, there is still Drone that does not have past version states...

Abelarm · 2020-12-10T08:56:20Z

Sorry I didn't get exactly what is the problem, and hence how I am supposed to solve it :(

mergify bot requested a review from a team October 20, 2020 10:57

tchaton requested changes Oct 20, 2020

View reviewed changes

Borda reviewed Oct 20, 2020

View reviewed changes

setup.py Outdated Show resolved Hide resolved

mergify bot requested a review from a team October 20, 2020 14:36

Abelarm requested review from tchaton and removed request for a team October 21, 2020 14:28

mergify bot requested a review from a team October 21, 2020 14:29

stale bot added the won't fix This will not be worked on label Nov 4, 2020

Borda added docs Documentation related feature Is an improvement or enhancement and removed won't fix This will not be worked on labels Nov 4, 2020

Borda self-assigned this Nov 4, 2020

tchaton requested review from SeanNaren, ananyahjha93, awaelchli, justusschock, nateraw, teddykoker and williamFalcon as code owners November 11, 2020 11:44

Borda self-requested a review November 30, 2020 19:51

Borda added this to the 1.1 milestone Nov 30, 2020

Borda added 5 commits December 1, 2020 19:53

format

e7727b0

fix

d1facfe

fix

2c46633

prune

33fa612

fiix

6a6fa1c

Borda force-pushed the donwload_badges branch from 11bea37 to 6a6fa1c Compare December 1, 2020 18:53

Borda added 3 commits December 1, 2020 20:06

fiix

a1852ba

flake8

7cb7946

fix

7dfc569

Borda added 4 commits December 1, 2020 20:20

imports

984d69a

imports

5c7da5d

imports

58f8a37

fixx

60c6a09

Borda and others added 4 commits December 1, 2020 20:49

impoets

8b04a7c

win

a96fb49

Merge branch 'master' into donwload_badges

bdc3274

min

f93b947

SeanNaren approved these changes Dec 1, 2020

View reviewed changes

Borda added the ready PRs ready to be merged label Dec 1, 2020

Merge branch 'master' into donwload_badges

58d246a

Borda merged commit a941f96 into Lightning-AI:master Dec 1, 2020

Borda mentioned this pull request Dec 4, 2020

Fix pipy badges and images not rendering #4978

Closed

Added the function for downloading the badges locally and replace the url with downlaod path #4250

Added the function for downloading the badges locally and replace the url with downlaod path #4250

Uh oh!

Conversation

Abelarm commented Oct 20, 2020 • edited by ydcjeff Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before submitting

PR review

Did you have fun?

Uh oh!

pep8speaks commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2020-12-01 21:07:29 UTC

Uh oh!

Abelarm commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tchaton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tchaton Oct 20, 2020

Choose a reason for hiding this comment

Uh oh!

Abelarm Oct 20, 2020

Choose a reason for hiding this comment

Uh oh!

ydcjeff commented Oct 20, 2020

Uh oh!

Uh oh!

Abelarm commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stale bot commented Nov 4, 2020

Uh oh!

Borda commented Nov 30, 2020

Uh oh!

Borda commented Nov 30, 2020

Uh oh!

Abelarm commented Dec 1, 2020

Uh oh!

Abelarm commented Dec 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Borda commented Dec 1, 2020

Uh oh!

Borda commented Dec 1, 2020

Uh oh!

Borda commented Dec 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Abelarm commented Dec 9, 2020 • edited by Borda Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Borda commented Dec 9, 2020

Uh oh!

Abelarm commented Dec 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Abelarm commented Oct 20, 2020 •

edited by ydcjeff

Loading

pep8speaks commented Oct 20, 2020 •

edited

Loading

Abelarm commented Oct 20, 2020 •

edited

Loading

codecov bot commented Oct 20, 2020 •

edited

Loading

Abelarm commented Oct 20, 2020 •

edited

Loading

Abelarm commented Dec 1, 2020 •

edited

Loading

Borda commented Dec 2, 2020 •

edited

Loading

Abelarm commented Dec 9, 2020 •

edited by Borda

Loading

Abelarm commented Dec 10, 2020 •

edited

Loading