-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor: remove ipyleaflet-core and have only ipyleaflet and
jupyter-leaflet packages This will ease the releasing so much. ipyleaflet-core itself was not really useful on its own anyway.
- Loading branch information
1 parent
8a286fc
commit 1ee026f
Showing
29 changed files
with
151 additions
and
212 deletions.
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 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.