Merge branch 'master' into jb/mvttilelayer-highlight

visgl · Apr 29, 2020 · bcbc750 · bcbc750
2 parents 8ec5756 + 9dd1828
commit bcbc750
Show file tree

Hide file tree

Showing 383 changed files with 3,046 additions and 2,199 deletions.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -8,6 +8,6 @@ assignees: ''
 ---
 
 <!-- Ask a question that is not answered in our (documentation)[http://deck.gl/#/documentation]. -->
-<!-- Also check answered issues tagged as (FAQ)[https://github.com/uber/deck.gl/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Afaq]-->
+<!-- Also check answered issues tagged as (FAQ)[https://github.com/visgl/deck.gl/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Afaq]-->
 
 <!-- Suggest an improvement or clarification in our documentation. -->
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -11,5 +11,8 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
+  version: 3.7
   install:
-    - requirements: bindings/pydeck/requirements-dev.txt
+    - requirements: bindings/pydeck/requirements/requirements-dev.txt
+    - requirements: bindings/pydeck/requirements/requirements-rtd.txt
+  system_packages: true
diff --git a/.travis.yml b/.travis.yml
@@ -23,7 +23,7 @@ matrix:
       install:
         - yarn bootstrap
       node_js:
-        - 10.16.0
+        - 12.12.0
       before_script:
         - export DISPLAY=:99.0; sh -e /etc/init.d/xvfb start
         - ulimit -c unlimited -S       # enable core dumps
@@ -52,9 +52,9 @@ matrix:
         directories:
           - ~/.npm  # NPM cache
       install:
-        - pip install -r requirements.txt
-        - pip install -r requirements-dev.txt
-        - nvm install 10.16.0
-        - nvm use 10.16.0
+        - pip install -r requirements/requirements.txt
+        - pip install -r requirements/requirements-dev.txt
+        - nvm install 12.12.0
+        - nvm use 12.12.0
         - pip install -e . --install-option "--build_all" --verbose
-      script: pytest --cov=pydeck
+      script: make test
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,20 @@ Each version should:
 Ref: http://keepachangelog.com/en/0.3.0/
 -->
 
+## deck.gl v8.2
+
+#### deck.gl [8.2.0-alpha.0] - Apr 1 2020
+
+- Fix GeoJSON multi-geometry highlighting (#4426)
+- Add flowmap to showcases (#4430)
+- @deck.gl/jupyter-widget: Remove Tile3DLoader (#4438)
+- @deck.gl/jupyter-widget and pydeck: Fix binary data bug (#4416)
+- pydeck/jupyter-widget: Call mergeConfiguration again after addCustomLibraries complete (#4413)
+- Add zRange prop to TileLayer for use with TerrainLayer (#4397)
+- Fix PointCloud sizeUnits as "meters" (#4421)
+- Fix GeoJsonLayer's handling of highlightedObjectIndex (#4403)
+- layers: pass loadOptoins to IconManager from IconLayer (#4404)
+
 ## deck.gl v8.1
 
 #### deck.gl [8.1.0] - Mar 17 2020
@@ -2383,7 +2397,7 @@ haders
 
 #### [4.1.0] - 2017-7-27 Minor deck.gl Release
 
-For details see [What's New](https://github.com/uber/deck.gl/blob/5.0-release/docs/whats-new.md)
+For details see [What's New](https://github.com/visgl/deck.gl/blob/5.0-release/docs/whats-new.md)
 
 
 ### deck.gl v4.1 Beta Releases
@@ -3069,7 +3083,7 @@ For details see [What's New](docs/whats-new.md)
 - Retina display support
 - Performance refactoring
 - Switched the underlying rendering framework to
-  [luma.gl](https://github.com/uber/luma.gl)
+  [luma.gl](https://github.com/visgl/luma.gl)
 - Fixed picking on retina/regular display
 
 ## deck.gl v1

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,3 @@
+# Code of Conduct
+
+vis.gl is part of the [Urban Computing Foundation](https://uc.foundation/), supported by the Linux Foundation. Please be mindful of and adhere to the Linux Foundation's [Code of Conduct](https://lfprojects.org/policies/code-of-conduct/) when contributing to deck.gl.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+## Contributing to deck.gl
+
+**Thanks for taking the time to contribute!**
+
+PRs and bug reports are welcome, and we are actively looking for new maintainers.
+
+
+## Setting Up Dev Environment
+
+The **master** branch is the active development branch.
+
+Building deck.gl locally from the source requires node.js `>=10`. Further limitations on the Node version may be imposed by [puppeteer](https://github.com/puppeteer/puppeteer#usage) and [headless-gl](https://github.com/stackgl/headless-gl#supported-platforms-and-nodejs-versions).
+We use [yarn](https://yarnpkg.com/en/docs/install) to manage the dependencies of deck.gl.
+
+```bash
+git checkout master
+yarn bootstrap
+yarn test
+```
+
+Run the layer browser application:
+
+```bash
+cd examples/layer-browser
+yarn
+yarn start-local
+```
+
+If you consider opening a PR, here is some documentation to get you started:
+
+- vis.gl [developer process](https://www.github.com/visgl/tsc/tree/master/developer-process)
+- [deck.gl API design guidelines](/dev-docs/deckgl-api-guidelines.md)
+
+
+## Community Governance
+
+vis.gl is part of the [Urban Computing Foundation](https://uc.foundation/). See the organization's [Technical Charter](https://github.com/visgl/tsc/blob/master/Technical%20Charter.md).
+
+
+### Technical Steering Committee
+
+deck.gl development is governed by the vis.gl Technical Steering Committee (TSC). Current members:
+
+- [Ib Green](https://github.com/ibgreen)
+- [Xiaoji Chen](https://github.com/Pessimistress) - chairperson
+- [Tarek Sherif](https://github.com/tsherif)
+- [Ravi Akkenapally](https://github.com/1chandu)
+
+
+### Maintainers
+
+- [Andrew Duberstein](https://github.com/ajduberstein) - pydeck, json
+- [Xintong Xia](https://github.com/xintongxia) - layers
+- [Georgios Karnas](https://github.com/georgios-uber) - glTF
+- [Dario D'Amico](https://github.com/damix911) - ArcGIS
+- [Jesús Botella](https://github.com/jesusbotella) - MVT
+
+Maintainers of deck.gl have commit access to this GitHub repository, and take part in the decision making process.
+
+If you are interested in becoming a maintainer, read the [governance guidelines](https://github.com/visgl/tsc/tree/master/developer-process/governance.md).
+
+The vis.gl TSC meets monthly and publishes meeting notes via a [mailing list](https://lists.uc.foundation/g/visgl).
+This mailing list can also be utilized to reach out to the TSC.  
+
+
+## Code of Conduct
+
+Please be mindful of and adhere to the Linux Foundation's [Code of Conduct](https://lfprojects.org/policies/code-of-conduct/) when contributing to deck.gl.
diff --git a/README.md b/README.md
@@ -2,22 +2,22 @@
   <a href="https://npmjs.org/package/deck.gl">
     <img src="https://img.shields.io/npm/v/deck.gl.svg?style=flat-square" alt="version" />
   </a>
-  <a href="https://travis-ci.com/uber/deck.gl">
-    <img src="https://api.travis-ci.com/uber/deck.gl.svg?branch=master" alt="build" />
+  <a href="https://travis-ci.com/visgl/deck.gl">
+    <img src="https://api.travis-ci.com/visgl/deck.gl.svg?branch=master" alt="build" />
   </a>
   <a href="https://npmjs.org/package/deck.gl">
     <img src="https://img.shields.io/npm/dm/deck.gl.svg?style=flat-square" alt="downloads" />
   </a>
-  <a href='https://coveralls.io/github/uber/deck.gl?branch=master'>
-    <img src='https://img.shields.io/coveralls/uber/deck.gl.svg?style=flat-square' alt='Coverage Status' />
+  <a href='https://coveralls.io/github/visgl/deck.gl?branch=master'>
+    <img src='https://img.shields.io/coveralls/visgl/deck.gl.svg?style=flat-square' alt='Coverage Status' />
   </a>
 </p>
 
-<h1 align="center">deck.gl | <a href="https://uber.github.io/deck.gl">Website</a></h1>
+<h1 align="center">deck.gl | <a href="https://deck.gl">Website</a></h1>
 
 <h5 align="center"> WebGL2-powered, highly performant large-scale data visualization</h5>
 
-[![docs](http://i.imgur.com/mvfvgf0.jpg)](https://uber.github.io/deck.gl)
+[![docs](http://i.imgur.com/mvfvgf0.jpg)](https://visgl.github.io/deck.gl)
 
 
 deck.gl is designed to simplify high-performance, WebGL-based visualization of large data sets. Users can quickly get impressive visual results with minimal effort by composing existing layers, or leverage deck.gl's extensible architecture to address custom needs.
@@ -42,7 +42,7 @@ Deck.gl is designed to be highly customizable. All layers come with flexible API
 ```
 
 - [Get started](/docs/get-started/using-standalone.md#using-the-scripting-api)
-- [Full examples](https://github.com/uber/deck.gl/tree/master/examples/get-started/scripting)
+- [Full examples](https://github.com/visgl/deck.gl/tree/master/examples/get-started/scripting)
 
 ### NPM Module
 
@@ -82,14 +82,13 @@ pip install pydeck
 * [Interactive playground](https://deck.gl/playground)
 * [deck.gl Codepen demos](https://codepen.io/vis-gl/)
 * [deck.gl Observable demos](https://beta.observablehq.com/@pessimistress)
-* [vis.gl Medium blog](https://medium.com/vis-gl) 
+* [vis.gl Medium blog](https://medium.com/vis-gl)
 * [deck.gl Slack workspace](https://join.slack.com/t/deckgl/shared_invite/zt-7oeoqie8-NQqzSp5SLTFMDeNSPxi7eg)
 
 ## Contributing
 
-Pull requests and bug reports are welcome, and all of deck.gl's roadmaps and feature planning is done openly on GitHub. Read the [developement guidelines](/dev-docs) to learn about our dev process.
+deck.gl is part of vis.gl, a [Urban Computing Foundation](https://uc.foundation/) project. Read the [contribution guidelines](/CONTRIBUTING.md) if you are intrested in contributing.
 
-Note that once your PR is about to be merged, you will be asked to register as a contributor by filling in a short form.
 
 ## Attributions
 
@@ -103,4 +102,3 @@ Data sources are listed in each example.
 <a href="https://www.browserstack.com/">
  <img src="https://d98b8t1nnulk5.cloudfront.net/production/images/static/logo.svg" alt="BrowserStack" width="200" />
 </a>
-
diff --git a/bindings/pydeck/.flake8 b/bindings/pydeck/.flake8
@@ -0,0 +1,5 @@
+[flake8]
+ignore = E203, E266, E501, W503, F403, F401
+max-line-length = 120
+max-complexity = 18
+select = B,C,E,F,W,T4,B9
diff --git a/bindings/pydeck/.gitignore b/bindings/pydeck/.gitignore
@@ -26,6 +26,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+pip-wheel-metadata/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -153,6 +154,9 @@ $RECYCLE.BIN/
 **/pydeck/nbextension/static/index.js
 **/pydeck/nbextension/static/index.js.map
 **/_build
-**/pydeck/frontend_semver.py
-**/examples/scripts/*.html
+# Docs and examples html pages
 **/examples/*.png
+**/examples/*.html
+# Ignore autogenerated HTML and RST files
+**/docs/gallery/*.rst
+**/docs/gallery/html/*.html
diff --git a/bindings/pydeck/LICENSE.txt b/bindings/pydeck/LICENSE.txt
@@ -1,27 +1,13 @@
-Copyright (c) 2020 Uber Technologies Inc.
-All rights reserved.
+   Copyright 2020 vis.gl, a Series of LF Projects, LLC
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+       http://www.apache.org/licenses/LICENSE-2.0
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/bindings/pydeck/Makefile b/bindings/pydeck/Makefile
@@ -1,18 +1,27 @@
+help:
+	@echo "Please use `make target' where target is one of"
+	@echo "pre-init - Set up a virtual environment and activate it"
+	@echo "init - Build deck.gl, install all requirements, and activate the plugin for Jupyter"
+	@echo "test - Run pytest tests"
+	@echo "bump-version - Bump the version files for the pydeck frontend and backend"
+	@echo "release - package and upload a release"
+	@echo "prepare-jupyter - initiate pydeck-related extensions in JupyterLab and Jupyter Notebook"
+
 init:
 	# Build deck.gl at the root of this repository
 	cd ../..; yarn bootstrap; cd -; \
 	# Set up the pydeck project
-	pip install -r requirements.txt; \
-        pip install -r requirements-dev.txt; \
+	pip install -r requirements/requirements.txt; \
+	pip install -r requirements/requirements-dev.txt; \
 	pip install -e . ; \
 	$(MAKE) prepare-jupyter
 
+pre-commit:
+	black . --target-version py34 && $(MAKE) test
+
 pre-init:
-	# Installs basic Python requirements
-	# Only useful if you're coming from a setup with no Python installed
 	python3 -m venv env; \
-	. env/bin/activate; \
-	$(MAKE) init
+	. env/bin/activate
 
 prepare-jupyter:
 	# Enable the notebook extension
@@ -27,15 +36,11 @@ prepare-jupyter:
 	  cd ../../bindings/pydeck
 
 test:
-	pytest
-
-screenshot-examples:
-	pip install pyppeteer
-	python examples/scripts/update_docs.py
+	flake8 {pydeck,tests,*.py,examples} && \
+	pytest --cov=pydeck 
 
-docs:
-	cd docs; \
-	$(MAKE) html
+publish-conda:	
+	@echo "NOTE pydeck does not yet publish to conda-forge. Awaiting #4202."
 
 bump-version:
 	@read -p "Choose a release type {MAJOR, MINOR, PATCH, BETA, ALPHA, RC}:" choice; \
@@ -55,7 +60,7 @@ publish-test-pypi:
 	pip install twine
 	python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
-bump-and-publish:
+release:
 	$(MAKE) bump-version;
 	$(MAKE) test;
 	VERSION=$$(python -c "import pydeck; print(pydeck.__version__)");

diff --git a/bindings/pydeck/PUBLISH.md b/bindings/pydeck/PUBLISH.md
@@ -19,8 +19,8 @@ environments:
 
 - `.show()` in a Jupyter Notebook
 - `.to_html()` in a Jupyter Notebook
-- `.show()` in Jupyter Lab
-- `.to_html()` in Jupyter Lab
+- `.show()` in JupyterLab
+- `.to_html()` in JupyterLab
 - `.to_html()` in a Python REPL
 
 2) Run `make bump-and-publish` and select the kind of release at the prompt.

diff --git a/bindings/pydeck/README.md b/bindings/pydeck/README.md
@@ -1,5 +1,5 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/uber/deck.gl/binder)
-[![Documentation Status](https://readthedocs.org/projects/deckgl/badge/?version=latest)](https://deckgl.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/deckgl/badge/?version=latest)](https://pydeck.gl)
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pydeck/badges/version.svg)](https://anaconda.org/conda-forge/pydeck)
 
 # pydeck: Large-scale interactive data visualization in Python
@@ -14,7 +14,7 @@ For __interactive demos__, click the binder logo below:
 [![Binder](https://mybinder.org/static/logo.svg?v=f9f0d927b67cc9dc99d788c822ca21c0)](https://mybinder.org/v2/gh/uber/deck.gl/binder)
 
 
-[See further documentation here.](https://deckgl.readthedocs.io/en/latest/)
+See the documentation at the [pydeck website](https://pydeck.gl)
 
 ## Installation
 
@@ -39,7 +39,8 @@ To install pydeck for JupyterLab, run the following:
 
 ```bash
 jupyter labextension install @jupyter-widgets/jupyterlab-manager
-jupyter labextension install @deck.gl/jupyter-widget
+DECKGL_SEMVER=`python -c "import pydeck; print(pydeck.frontend_semver.DECKGL_SEMVER)"`
+jupyter labextension install @deck.gl/jupyter-widget@$DECKGL_SEMVER
 ```
 
 ### Mapbox API token
@@ -102,15 +103,15 @@ Error handling will be expanded in future versions of pydeck.
 
 ### Issues
 
-If you encounter an issue, file it in the [deck.gl issues page](https://github.com/uber/deck.gl/issues/new?assignees=&labels=question&template=question.md&title=)
+If you encounter an issue, file it in the [deck.gl issues page](https://github.com/visgl/deck.gl/issues/new?assignees=&labels=question&template=question.md&title=)
 and include your browser's console output, if any.
 
 
 ### Installation from source
 
 ```bash
 # Clone the deck.gl repo
-git clone https://github.com/uber/deck.gl/
+git clone https://github.com/visgl/deck.gl/
 
 # Navigate to the pydeck module
 cd deck.gl/bindings/pydeck