-
Notifications
You must be signed in to change notification settings - Fork 107
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
Move dependencies from requirements files into pyproject.toml, add extra groups for dev, docs #565
base: development
Are you sure you want to change the base?
Conversation
👈 Launch a binder notebook on this branch for commit 0c992db I will automatically update this comment whenever this PR is modified 👈 Launch a binder notebook on this branch for commit 6f84616 👈 Launch a binder notebook on this branch for commit 97c765e 👈 Launch a binder notebook on this branch for commit 3261cc9 👈 Launch a binder notebook on this branch for commit b1935b2 👈 Launch a binder notebook on this branch for commit 075f1f8 |
|
||
|
||
Contributing for the first time | ||
------------------------------- | ||
1. If you don't have one, sign up for a GitHub account (visit https://github.com/ and ‘sign up for GitHub account’). | ||
|
||
2. Clone the icepyx repo: Open a terminal window. | ||
Navigate to the folder on your computer where you want to store icepyx. | ||
For example, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## development #565 +/- ##
============================================
Coverage 65.98% 65.98%
============================================
Files 36 36
Lines 3052 3052
Branches 538 538
============================================
Hits 2014 2014
Misses 950 950
Partials 88 88 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope you don't mind, I took a pass at the contributing doc and made some formatting fixes and re-organized things a little bit in a way that I thought would make it more accessible. Would love some input!
In this case, the documentation changes (which are quite substantial) should probably be a separate PR... One reason is so that we have 2 changelog entries, one under the the 'Documentation' section and one under 'Maintenance'.
97c765e
to
3261cc9
Compare
3261cc9
to
b1935b2
Compare
b1935b2
to
075f1f8
Compare
😩 Two hours ago, Ruff enabled formatting and checking of Jupyter Notebooks by default. New PR coming for that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't reviewed it line-by-line yet, but see my comment in #552.
I'm not sure what changes you're requesting here or what the dealbreaker is, could you provide some more info? We're still doing an editable install with pip in this proposal like in the current documentation -- having pip in the conda environment is not a new requirement. The main difference is representing the optional/extra dependencies in a standard way in project metadata. The proposed workflow here will work the same with a python venv, with conda, or with another tool to manage the environment. I think what you may be remembering is pip's unfortunate history before it was capable of dependency resolution. Back then, it would install the packages you requested in order, and if dependencies conflicted, it would choose the last one and blow away the needs of previous packages! But now it does truly resolve dependencies: https://pip.pypa.io/en/stable/topics/dependency-resolution/ |
Resolves #552
I hope you don't mind, I took a pass at the contributing doc and made some formatting fixes and re-organized things a little bit in a way that I thought would make it more accessible. Would love some input!