Name | eerepr JSON |
Version |
0.0.4
JSON |
| download |
home_page | None |
Summary | Code Editor-style reprs for Earth Engine data in a Jupyter notebook. |
upload_time | 2022-12-01 05:52:24 |
maintainer | None |
docs_url | None |
author | Aaron Zuspan |
requires_python | >=3.7 |
license | MIT License
Copyright (c) 2022 Aaron Zuspan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
keywords |
earthengine
gee
html
jupyter
notebook
reprs
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# eerepr
[![Earth Engine Python](https://img.shields.io/badge/Earth%20Engine%20API-Python-green)](https://developers.google.com/earth-engine/tutorials/community/intro-to-python-api)
[![PyPI version](https://badge.fury.io/py/eerepr.svg)](https://badge.fury.io/py/eerepr)
[![conda-forge link](https://img.shields.io/conda/vn/conda-forge/eerepr)](https://anaconda.org/conda-forge/eerepr)
[![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.org/github/aazuspan/eerepr/blob/main/docs/notebooks/demo.ipynb)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aazuspan/eerepr/HEAD?labpath=docs%2Fnotebooks%2Fdemo.ipynb)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/aazuspan/eerepr/blob/main/docs/notebooks/demo.ipynb)
Add interactive Code Editor-style HTML reprs to Earth Engine objects in a Jupyter environment.
![eerepr demo expanding the metadata for an image collection](assets/eerepr.gif)
## Setup
Install from PyPI:
```bash
$ pip install eerepr
```
Install from Conda-Forge:
```bash
$ conda install -c conda-forge eerepr
```
## Usage
```python
import eerepr
```
Importing `eerepr` in a Jupyter notebook adds an HTML repr method to all Earth Engine objects. When you print them, you'll see an interactive HTML repr instead of a boring old string repr. Simple as that!
> **Note**
> Just like in the Code Editor, printing huge collections can be slow and may hit memory limits.
## Caching
`eerepr` uses caching to improve performance. Server data will only be requested once for each unique Earth Engine object, and all subsequent requests will be retrieved from the cache until the Jupyter session is restarted.
When you import `eerepr`, it is automatically initialized with an unlimited cache size. You can manually set the number of unique objects to cache using `eerepr.initialize(max_cache_size=n)`. A value of `None` sets an unlimited cache while a value of `0` disables caching.
Raw data
{
"_id": null,
"home_page": null,
"name": "eerepr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "earthengine,gee,html,jupyter,notebook,reprs",
"author": "Aaron Zuspan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/46/bd/d8622645bcd83bd58e9b4613dbb1a3d294663116343ac9ca85902f9863ba/eerepr-0.0.4.tar.gz",
"platform": null,
"description": "# eerepr\n\n[![Earth Engine Python](https://img.shields.io/badge/Earth%20Engine%20API-Python-green)](https://developers.google.com/earth-engine/tutorials/community/intro-to-python-api)\n[![PyPI version](https://badge.fury.io/py/eerepr.svg)](https://badge.fury.io/py/eerepr)\n[![conda-forge link](https://img.shields.io/conda/vn/conda-forge/eerepr)](https://anaconda.org/conda-forge/eerepr)\n[![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.org/github/aazuspan/eerepr/blob/main/docs/notebooks/demo.ipynb)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aazuspan/eerepr/HEAD?labpath=docs%2Fnotebooks%2Fdemo.ipynb)\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/aazuspan/eerepr/blob/main/docs/notebooks/demo.ipynb)\n\nAdd interactive Code Editor-style HTML reprs to Earth Engine objects in a Jupyter environment.\n\n![eerepr demo expanding the metadata for an image collection](assets/eerepr.gif)\n\n## Setup\n\nInstall from PyPI:\n\n```bash\n$ pip install eerepr\n```\n\nInstall from Conda-Forge:\n\n```bash\n$ conda install -c conda-forge eerepr\n```\n\n## Usage\n\n```python\nimport eerepr\n```\n\nImporting `eerepr` in a Jupyter notebook adds an HTML repr method to all Earth Engine objects. When you print them, you'll see an interactive HTML repr instead of a boring old string repr. Simple as that!\n\n> **Note**\n> Just like in the Code Editor, printing huge collections can be slow and may hit memory limits.\n\n## Caching\n\n`eerepr` uses caching to improve performance. Server data will only be requested once for each unique Earth Engine object, and all subsequent requests will be retrieved from the cache until the Jupyter session is restarted.\n\nWhen you import `eerepr`, it is automatically initialized with an unlimited cache size. You can manually set the number of unique objects to cache using `eerepr.initialize(max_cache_size=n)`. A value of `None` sets an unlimited cache while a value of `0` disables caching.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2022 Aaron Zuspan\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Code Editor-style reprs for Earth Engine data in a Jupyter notebook.",
"version": "0.0.4",
"split_keywords": [
"earthengine",
"gee",
"html",
"jupyter",
"notebook",
"reprs"
],
"urls": [
{
"comment_text": null,
"digests": {
"md5": "b67934549157eaf4dd0f2c8e197b1c66",
"sha256": "79595fd643e99d91a68041cdba3f5347d5559e6744a34983291a46cada6edbd4"
},
"downloads": -1,
"filename": "eerepr-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b67934549157eaf4dd0f2c8e197b1c66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9678,
"upload_time": "2022-12-01T05:52:21",
"upload_time_iso_8601": "2022-12-01T05:52:21.808444Z",
"url": "https://files.pythonhosted.org/packages/0b/71/5a5e36ad755e3e3081b43acf9ac2a50d1f6f88211aa278bb80114d0b6cd6/eerepr-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"md5": "d5329fbffdb150e241e999c842970d43",
"sha256": "920cccbe498b2880f42ed39a2db8945f705b1497523c48b8d392c5380d511926"
},
"downloads": -1,
"filename": "eerepr-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d5329fbffdb150e241e999c842970d43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7417,
"upload_time": "2022-12-01T05:52:24",
"upload_time_iso_8601": "2022-12-01T05:52:24.378763Z",
"url": "https://files.pythonhosted.org/packages/46/bd/d8622645bcd83bd58e9b4613dbb1a3d294663116343ac9ca85902f9863ba/eerepr-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 05:52:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "eerepr"
}