Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #2457 make jupyter a dev only dependency #2846

Conversation

arjxn-py
Copy link
Member

@arjxn-py arjxn-py commented Apr 1, 2023

Description

Made jupyter a development only dependency instead of required dependency.

Fixes #2457

Type of change

Jupyter has been moved from required dependency to development only dependency in requirements.txt & setup.py and also been added as a testing dependency in tox.ini.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all
  • The documentation builds: $ python run-tests.py --doctest

You can run unit and doctests together at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link

codecov bot commented Apr 1, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (08dc8f7) 99.69% compared to head (ba89a07) 99.69%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2846   +/-   ##
========================================
  Coverage    99.69%   99.69%           
========================================
  Files          273      273           
  Lines        19065    19065           
========================================
  Hits         19006    19006           
  Misses          59       59           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@arjxn-py
Copy link
Member Author

arjxn-py commented Apr 1, 2023

@tinosulzer I have listed the packages that were dependent on Jupyter in required dependencies but now the tests are failing while running example notebooks most likely on this line - %pip install pybamm -q giving syntax error.
I would be grateful If I could get some suggestion on it.

@valentinsulzer
Copy link
Member

you should install jupyter in tox.ini before running the example tests

@arjxn-py arjxn-py marked this pull request as draft April 1, 2023 14:59
@arjxn-py arjxn-py marked this pull request as ready for review April 2, 2023 08:38
@arjxn-py
Copy link
Member Author

arjxn-py commented Apr 2, 2023

@tinosulzer Thankfully, almost all the tests are passing now. Though i'm not sure about the Lynchee one.

setup.py Outdated Show resolved Hide resolved
@valentinsulzer
Copy link
Member

won't jupyter install nbconvert (i.e. no need to make explicit)

@arjxn-py
Copy link
Member Author

arjxn-py commented Apr 2, 2023

won't jupyter install nbconvert (i.e. no need to make explicit)

I listed it to avoid the potential risk to examples tests failing, but yes jupyter should install nbconvert with it so I am looking into it.
Thanks for suggesting.

tox.ini Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
@arjxn-py
Copy link
Member Author

arjxn-py commented Apr 3, 2023

One of the integration test is failing but I don't think I've made any changes in that regard.

@arjxn-py arjxn-py requested a review from Saransh-cpp April 3, 2023 06:39
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @arjxn-py! Looks good to me!

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you update changelog (add this as a breaking change)?

@arjxn-py
Copy link
Member Author

arjxn-py commented Apr 3, 2023

Can you update changelog (add this as a breaking change)?

Yes i'll do that.

@valentinsulzer valentinsulzer merged commit 87c0696 into pybamm-team:develop Apr 3, 2023
@arjxn-py arjxn-py deleted the Issue-#2457-Make-jupyter-a-dev-only-dependency branch May 6, 2023 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make jupyter a dev-only dependency
3 participants