-
Notifications
You must be signed in to change notification settings - Fork 363
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
Refactor: remove ipyleaflet-core and have only ipyleaflet and jupyter-leaflet packages #1189
Merged
martinRenou
merged 8 commits into
jupyter-widgets:master
from
martinRenou:remove_core_pkg
Apr 23, 2024
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1ee026f
Refactor: remove ipyleaflet-core and have only ipyleaflet and
martinRenou beacea9
Attempt to fix README GIFs in symlink
martinRenou 3c870c6
fix README GIFs in symlink
martinRenou b558cc5
Fix missing dynamic entry
martinRenou 5fa2461
Unneeded jupyterlab dependency in build env + couple of fixes
martinRenou 784c0f6
Fix version for now
martinRenou 88aba01
Fix release steps
martinRenou e7ddafc
Fix path to README
martinRenou File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
python/ipyleaflet/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,21 +4,23 @@ | |
```sh | ||
git clone [email protected]:jupyter-widgets/ipyleaflet.git | ||
``` | ||
2. Update the version numbers in the following files (see https://github.com/jupyter-widgets/ipyleaflet/commit/48f3cb68cd07e6c4ae7b353a17861e4e51ca4471) | ||
- `ipyleaflet/ipyleaflet_core/ipyleaflet/_version.py` (two places) | ||
- `ipyleaflet/python/jupyter_leaflet/package.json` | ||
2. Update the version numbers in the following files | ||
- `python/ipyleaflet/_version.py` (two places) | ||
- `python/jupyter_leaflet/package.json` | ||
- `environment.yml` | ||
3. Make sure the changelog is updated: `CHANGELOG.md` | ||
4. Build and publish to npm (if yarn prompts for the new version, I give the same as what is already in the `package.json`) | ||
```sh | ||
cd ipyleaflet/python/jupyter_leaflet | ||
cd python/jupyter_leaflet | ||
yarn install && yarn run build && yarn publish | ||
cd .. | ||
``` | ||
5. Build and publish Python package | ||
```sh | ||
python -m build | ||
twine upload dist/* | ||
python -m build python/jupyter_leaflet | ||
twine upload python/jupyter_leaflet/dist/* | ||
python -m build python/ipyleaflet | ||
twine upload python/ipyleaflet/dist/* | ||
``` | ||
6. Update environment config with new ipyleaflet pypi download link: `docs/jupyterlite_config.json` | ||
7. Commit and push in git | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,118 @@ | ||
ipyleaflet meta package | ||
# ipyleaflet | ||
|
||
[![Documentation](http://readthedocs.org/projects/ipyleaflet/badge/?version=latest)](https://ipyleaflet.readthedocs.io/en/latest/?badge=latest) | ||
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter-widgets/ipyleaflet/stable?urlpath=lab%2Ftree%2Fexamples) | ||
[![Join the Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jupyter-widgets/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
[![Downloads](https://pepy.tech/badge/ipyleaflet/month)](https://pepy.tech/project/ipyleaflet/month) | ||
|
||
A Jupyter / Leaflet bridge enabling interactive maps in the Jupyter notebook. | ||
|
||
## Usage | ||
|
||
### Selecting a basemap for a leaflet map: | ||
|
||
![Basemap Screencast](basemap.gif) | ||
|
||
### Loading a geojson map: | ||
|
||
![GeoJSON Screencast](geojson.gif) | ||
|
||
### Making use of leafletjs primitives: | ||
|
||
![Primitives Screencast](primitives.gif) | ||
|
||
### Using the splitmap control: | ||
|
||
![Splitmap Screencast](splitmap.gif) | ||
|
||
### Displaying velocity data on the top of a map: | ||
|
||
![Velocity Screencast](velocity.gif) | ||
|
||
### Choropleth layer: | ||
|
||
![Choropleth Screencast](choropleth.gif) | ||
|
||
### Widget control | ||
|
||
![Widget Control](widget_control.gif) | ||
|
||
## Installation | ||
|
||
Using conda: | ||
|
||
``` | ||
conda install -c conda-forge ipyleaflet | ||
``` | ||
|
||
Using pip: | ||
|
||
``` | ||
pip install ipyleaflet | ||
``` | ||
|
||
If you are using the classic Jupyter Notebook < 5.3 you need to run this extra command: | ||
|
||
``` | ||
jupyter nbextension enable --py --sys-prefix ipyleaflet | ||
``` | ||
|
||
If you are using JupyterLab <=2, you will need to install the JupyterLab extension: | ||
|
||
``` | ||
jupyter labextension install @jupyter-widgets/jupyterlab-manager jupyter-leaflet | ||
``` | ||
|
||
## Installation from sources | ||
|
||
For a development installation (requires yarn, you can install it with `conda install -c conda-forge yarn`): | ||
|
||
``` | ||
git clone https://github.com/jupyter-widgets/ipyleaflet.git | ||
cd ipyleaflet | ||
(cd python/jupyter_leaflet ; pip install -e .) | ||
(cd python/ipyleaflet; pip install -e .) | ||
``` | ||
|
||
If you are using the classic Jupyter Notebook you need to install the nbextension: | ||
|
||
``` | ||
jupyter nbextension install --py --symlink --sys-prefix --overwrite ipyleaflet | ||
jupyter nbextension enable --py --sys-prefix ipyleaflet | ||
``` | ||
|
||
Note for developers: | ||
|
||
- the ``-e`` pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes. | ||
- the ``--symlink`` argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows. | ||
|
||
For developing with JupyterLab: | ||
|
||
``` | ||
jupyter labextension develop --overwrite ipyleaflet | ||
``` | ||
|
||
## Documentation | ||
|
||
To get started with using `ipyleaflet`, check out the full documentation | ||
|
||
https://ipyleaflet.readthedocs.io/ | ||
|
||
## License | ||
|
||
We use a shared copyright model that enables all contributors to maintain the | ||
copyright on their contributions. | ||
|
||
This software is licensed under the MIT license. See the [LICENSE](LICENSE) file for details. | ||
|
||
## Related projects | ||
|
||
The `ipyleaflet` repository includes the `jupyter-leaflet` npm package, which | ||
is a front-end component, and the `ipyleaflet` python package which is the | ||
backend for the Python Jupyter kernel. | ||
|
||
Similarly, the [`xleaflet`](https://github.com/jupyter-xeus/xleaflet/) project | ||
provides a backend to `jupyter-leaflet` for the "xeus-cling" C++ Jupyter | ||
kernel. | ||
|
||
![Xleaflet Screencast](xleaflet.gif) |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Would love to resolve that at some point. But let's not make it a blocker for the PR.