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

Cleanup requests dependency and move to examples group #19

Merged
merged 4 commits into from
Sep 6, 2024

Conversation

izofat
Copy link
Contributor

@izofat izofat commented Sep 5, 2024

No description provided.

@aclerc
Copy link
Contributor

aclerc commented Sep 5, 2024

thanks @izofat ! Sorry the issue was not very detailed, I think another point to address would be the README instructions, for example pip install -e .[dev] # or .[jupyter,dev] if you want jupyter dependencies as well might change to pip install -e .[dev] # or .[examples,dev] if you want dependencies for running the examples as well and in that case examples needs the jupyter dependencies. A simple 'all' dependency option would be nice too

@izofat
Copy link
Contributor Author

izofat commented Sep 5, 2024

Thanks for the feedback.
I moved the jupyter group to examples.
Added an all group for users that want to download all dependencies.
And updated the README file.
I wrote a part for users that want to just install example dependencies.
I can remove the example part if it is not necessary.

@aclerc
Copy link
Contributor

aclerc commented Sep 5, 2024

thank you @izofat , the README looks better. I think you can define groups from other groups rather than repeating dependencies which should make pyproject.toml more maintainable, could you please have a look? https://peps.python.org/pep-0735/#example-dependency-groups-table
do the examples run ok when you install [examples] and [all]?

@izofat
Copy link
Contributor Author

izofat commented Sep 5, 2024

@aclerc
I searched for grouping the dependencies but it's not possible in pyproject.toml if you check the link you mentioned depency-groups are not for installing.
Repeating the dependencies does not look good but we have to i guess.
If you find anything about grouping the dependencies feel free to commit the branch.
Examples run perfectly fine with [examples] and [all].
I would be thankful to contribute to project especially the python part. Don't bother to mention me in the issue

@aclerc aclerc self-requested a review September 6, 2024 07:49
@aclerc
Copy link
Contributor

aclerc commented Sep 6, 2024

@aclerc I searched for grouping the dependencies but it's not possible in pyproject.toml if you check the link you mentioned depency-groups are not for installing. Repeating the dependencies does not look good but we have to i guess. If you find anything about grouping the dependencies feel free to commit the branch. Examples run perfectly fine with [examples] and [all]. I would be thankful to contribute to project especially the python part. Don't bother to mention me in the issue

@izofat I found a solution after checking how the OpenOA repo does it https://github.com/NREL/OpenOA/blob/main/pyproject.toml

@aclerc aclerc merged commit 79b6493 into resgroup:main Sep 6, 2024
1 check passed
aclerc added a commit that referenced this pull request Sep 8, 2024
* Update smarteole_example.ipynb

fix issue, CACHE_SUBDIR is missing if data has never been downloaded

* Update smarteole_example.ipynb

fix ruff issue

* Update smarteole_example.ipynb

try to fix ruff issue

* fix issues after updating ruff

* Fix plotconfig mkdir (#16)

* remove make_plots_dir

* Update main_analysis.py

fix missing dir issue

* bump version

* Update smarteole_example.ipynb

* Update smarteole_example.ipynb

filter SmallSampleWarning

* Update smarteole_example.ipynb

fix ruff issue

* Create wind-up uplift validation methodology.pdf

* Cleanup  requests dependency and move to examples group (#19)

* Cleanup  requests dependency and move to examples group

* Jupyter group moved to examples and all group added

* Update pyproject.toml

define all using other groups

---------

Co-authored-by: Alex Clerc <[email protected]>

* support Python 3.9 (#17)

* try Python 3.9 in workflow

* Update lint-and-test.yaml

* try from __future__ import annotations

* Update conftest.py

* add eval-type-backport

* more from __future__ import annotations

* remove TypeAlias

* replace zip with strict_zip

* ignore 3.9 mypy issues

* fix bug in backporting.py

* Update lint-and-test.yaml

* Update lint-and-test.yaml

* Update pyproject.toml

move types-requests to dev

* Update smarteole_example.ipynb

* Update smarteole_example.ipynb

* Update smarteole_example.ipynb

* Define supported python (#23)

* add badge to README

* Update pyproject.toml

* Update lint-and-test.yaml

* update classifiers

* Update lint-and-test.yaml

* Update README.md

* Update smarteole_example.ipynb

* Update lint-and-test.yaml

* Update README.md

* Update smarteole_example.ipynb

* fix methodology link

---------

Co-authored-by: Gorkem Kacar <[email protected]>
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.

2 participants