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

grass.jupyter: Update __init__.py to only necessary modules #2312

Merged
merged 6 commits into from
Apr 26, 2022

Conversation

chaedri
Copy link
Contributor

@chaedri chaedri commented Apr 18, 2022

  • Remove reprojection_renderer and utils from init.py

These modules are not for direct by users of grass.jupyter. They are imported by other modules as needed. This will also shorted the API documentation page to only include modules intended for usage.

@chaedri chaedri requested a review from wenzeslaus April 18, 2022 14:44
@chaedri chaedri changed the title Update __init__.py to only necessary modules jupyter: Update __init__.py to only necessary modules Apr 18, 2022
Copy link
Member

@wenzeslaus wenzeslaus left a comment

Choose a reason for hiding this comment

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

This is a good start, but:

These modules are not for direct by users of grass.jupyter. They are imported by other modules as needed.

There are also functions or classes here and there which are internal, no? I think it would be best to avoid the start imports and import whatever we think should be here. (That's at least one technique how to do that.)

This will also shorted the API documentation page to only include modules intended for usage.

This would be great. However, I don't see that in the output, for example reprojection_renderer (I'm looking at the Sphinx doc artifact generated by the Pylint workflow). This is PR still worth doing even without this part.

@wenzeslaus wenzeslaus added this to the 8.2.0 milestone Apr 18, 2022
@wenzeslaus wenzeslaus changed the title jupyter: Update __init__.py to only necessary modules grass.jupyter: Update __init__.py to only necessary modules Apr 19, 2022
@wenzeslaus wenzeslaus added this to In progress in Integration with Jupyter Notebooks via automation Apr 19, 2022
@wenzeslaus wenzeslaus added the Python Related code is in Python label Apr 19, 2022
@wenzeslaus
Copy link
Member

Changed to include only public API objects. Notebooks work for me.

@petrasovaa petrasovaa merged commit 7a0780c into OSGeo:main Apr 26, 2022
Integration with Jupyter Notebooks automation moved this from In progress to Done Apr 26, 2022
@wenzeslaus wenzeslaus changed the title grass.jupyter: Update __init__.py to only necessary modules grass.jupyter: Update __init__.py to only necessary modules Apr 27, 2022
ninsbl pushed a commit to ninsbl/grass that referenced this pull request Oct 26, 2022
Co-authored-by: Vaclav Petras <wenzeslaus@gmail.com>
ninsbl pushed a commit to ninsbl/grass that referenced this pull request Feb 17, 2023
Co-authored-by: Vaclav Petras <wenzeslaus@gmail.com>
@chaedri chaedri deleted the init-update branch June 2, 2023 09:57
neteler pushed a commit to nilason/grass that referenced this pull request Nov 7, 2023
Co-authored-by: Vaclav Petras <wenzeslaus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Python Related code is in Python
Development

Successfully merging this pull request may close these issues.

None yet

3 participants