Initial commit

Co-authored-by: Dinu Gherman <dinu.gherman@here.com>
Co-authored-by: Sachin Kharude <sachin.kharude@here.com>

Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>

.darglint

@@ -0,0 +1,4 @@
+[darglint]
+strictness=short
+docstring_style=sphinx
+ignore_regex=^test_(.*)|^_(.*)

.gitignore

@@ -0,0 +1,12 @@
+.idea
+.coverage
+__pycache__
+.mypy_cache/
+.DS_Store
+htmlcov/
+.pytest_cache/
+_build/
+.ipynb_checkpoints/
+.venv
+.vscode
+.debug.env

.ort.yml

@@ -0,0 +1,9 @@
+---
+excludes:
+  paths:
+  - pattern: "requirements_dev.txt"
+    reason: "BUILD_TOOL_OF"
+    comment: "Optional dependencies only used for development / testing."
+  - pattern: "tests/**"
+    reason: "TEST_OF"
+    comment: "Directory only used for testing."

.travis.yml

@@ -0,0 +1,20 @@
+language: python
+python:
+  - "3.6"
+  - "3.7"
+  - "3.8"
+  - "3.9-dev"
+install:
+  - pip install -r requirements.txt
+  - pip install -e .[dev]
+script:
+- make clean
+- make lint
+- make typing
+- mkdir public
+- pytest -v --cov=xyzspaces tests | tee public/coverage.txt
+env:
+  global:
+  - secure: jjHEikFyl66DK16AbG6W6Wkku4M3H4AEccrXwkuxTPlzOOjlZbqZ/ZJnXF2A+3T16QvNab7kd+aa4dAgdcyKBwZs5/rR+L9jMDwkcOpYDXoXY1kiw3PE6wCb/lp1fay4KoxLUxwtcCg2KR/z8OR469W0ghRqCDJxECuuNarBAtOnvwPVCFeV6Q5b+1RqTyzEB7eJhdXMP3pwXW0Ix3JL6M1S7QzxvuI7N9huxoCZ0V1Jzuh70Eo1ORfnzu1Qt8eawkdb8/ph07FD2ETq+CNt7K3w/5RkrQsh//FXnEBiD3C8mzqMFGZSLmCAHot6/ni98CrZfVVwTOjMta+gMzuwoSfTXrBbZCkkOH9Bssg+R6GmDEfp1hVtMRUnVi0CHUAy3sS6bkqNFqAmbvFCoo6jI9k88d1iFoRR+uWg5IS0pNUBCS/OD9WD81nqFCeGrDi47LvTTGHLz6IpRapdA9gPMQuu3q+eIJqTJDr5hvuAKrgM8kkC3kqKl+hQpivF5bl468R+/Ej6P5MY09VHuT4MjOUA1M3IgbOTQ35XZ+XAhXR6W6wWYFRnk33LbESu7wnJteP48AFt8lKdWPluhiU6gbw+iHfxcd07404IywRuUuRM1PcOa874F756LyYp5rX/Qj7YR8gtBRiOHij4DwHuWNs7avM626q9lQ8CTomoSAY=
+  - secure: Btxn7PQjbm2suCcsAS1TUDA0w3duX27QJ0bnA7tI3jWUuG2kidqN/U7t8NFEjS7cB92MRelxiYn0RCdQQcTOHf6CwMgZMXTnCq6WVi+Sofh3Exj3zpiFCVr4fJMyPu1ko/IvuVqKPR62xOklBkDmKyjrRMP5bifPpS36hGRMXOavqwBO5vGMsUp+lItLZ1UXIbyd397GER3Dp1lxDwRDH6L/IM8xiRtcyooxGXhRtcnO5rB7Xe1nLiRrQWiy1/UJ+SuyGylrH9acMPp4xH6YbueXrHJasZujqb3c0xoS+HtDwUbMAfFc3FfDVnGqpaRrPLseTyqPNuIxN8dFkdH2tl7RlJXlLRqdMA94YuNF7MQ6174Jhc49xQVZN6F4E5033CY4zdUKaQ067palFRuTz9TYC31tLxBOhOr+uDfp4vJd0lo7GEeldLoRLj4OMJJE+ezQrz7E/9ewkL2+1+6tnF8I79kxGXsGARmeXi2yk7Qo/b3GGSeEmunjXK5VueHkwoJa8TKfN2phiev4ATc8HO8vAQCvTWieGCme9LUrHR1dYaqiEW0wDzOPKyfUDt/LO0nNDsp2y7dOcnGCagujHWdV8h0I5r4A2qUOrq0bDAjH0TnYbglN2/OD3JexzR4nu1i0AnLGaEh5xNvlHX9b3LiQwpvgQDVgUdfFHIskbN8=
+  - secure: vL7b5G8W4fBptwnXLn43Tm2F/jJ4x2ifl1ioIzFjLlxG8qQtcYl6pP1fCbNmMptFgAHun+s0vA6YMt6A9GdY/+8TbM9OfYzaNhhfTS+lrCqaYYi0xlJtvyqf73ncIWtQH5gp5Q5um2GtMOTPYkhxOVfRlFNgRwwQc3T1b1229r/5dOGikE+aY31CZOT6BHB1okJiwpkXo8FUNkqxEv/lQtRZI3TIrpdVnQtcdnRlU9cD/PSpG/c8wRhjE29Y/bI1k4rh/PpOqH0rOh1eHexVLGt9jCT4SUGc7+kfVmPpeJj5Rl+UeJEnjdtDPLxEYCXJ5rCUDoYqCYBfMOUOz8Wdd+gRiItAYhJEy9fQuwoBu8s/7ytyIMjosjhr8Sxv24Y2fgExSt1zqoKuJpJzJd+t8WZqEyY9mBy+tBmFqUsjNOabViMvGD4+cM6r26nkT6cYoJLa14K4R0Mgcpa+KUDeXrsfmoB53yMYe95cYDOQbd9spnXLRPlq2DHgX15rmbF6j5aIXXrKELrqfhUdEoQD9Bq7Szg0Sup7JJVTHbgEReftvhgRtQ+YLdwCMaVqpiIgxeFvR6yNcpAP/vQTu492b/Hh0pIeZVID6ORKeQ3VrS2KJgNwtSQa8BKQtw0smo+/FuQaW+l+OHxJhlamS0MJjoQ0FDoq/TWGvZDdpOVEKiU=

CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to XYZ Spaces for Python
+
+Thank you for taking the time to contribute.
+
+The following is a set of guidelines for contributing to this package.
+These are mostly guidelines, not rules. Use your best judgement and feel free to propose
+changes to this document in a pull request.
+
+## Coding Guidelines
+1. Lint your code contributions as per [pep8 guidelines](https://www.python.org/dev/peps/pep-0008/).
+
+To help you out, we have included a `Makefile` in the root directory which supports the commands below:
+
+Autoformat code using black:
+
+```bash
+make black
+```
+
+Check for typing errors:
+
+```bash
+make typing
+```
+
+Check for linting errors:
+
+```bash
+make lint
+```
+
+Run tests and coverage:
+
+```bash
+make test
+```
+
+2. Sort the imports in each python file as per [pep8 guidelines](https://www.python.org/dev/peps/pep-0008/#imports)
+   Please execute the isort utility to have the imports sorted auto-magically.
+
+#### Scripts
+
+The scripts below are present in [/scripts](./scripts) directory:
+
+- `build_apiref.sh` to create internal API reference documentation
+- `check_xyz_platform.py` runs a smoke test to check if the XYZ platform is alive and kicking
+- `walk_spaces.py` can serve as a template for building a maintenance script walking overall spaces
+
+#### Notebooks
+
+Example notebooks are provided in [/docs/notebooks](./docs/notebooks).
+
+## Signing each Commit
+
+When you file a pull request, we ask that you sign off the
+[Developer Certificate of Origin](https://developercertificate.org/) (DCO) in each commit.
+Any Pull Request with commits that are not signed off will be rejected by the
+[DCO check](https://probot.github.io/apps/dco/).
+
+A DCO is a lightweight way to confirm that a contributor wrote or otherwise has the right
+to submit code or documentation to a project. Simply add `Signed-off-by` as shown in the example below
+to indicate that you agree with the DCO.
+
+The git flag `-s` can be used to sign a commit:
+
+```bash
+git commit -s -m 'README.md: Fix minor spelling mistake'
+```
+
+The result is a signed commit message:
+
+```
+README.md: Fix minor spelling mistake
+
+Signed-off-by: John Doe <john.doe@example.com>
+```

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

MANIFEST.in

@@ -0,0 +1,14 @@
+include README.md
+include LICENSE
+include Makefile
+include requirements*.txt
+include binder/*
+include datasets/*
+include docs/notebooks/README.md docs/notebooks/*.ipynb
+exclude docs/notebooks/non-dist/*
+include scripts/*
+include tests/hub/* tests/project/* tests/token/*
+include images/* demo.ipynb
+exclude non-dist/*
+exclude ort
+include config/logconfig.json

Makefile

@@ -0,0 +1,51 @@
+.PHONY: all build install typing lint test
+
+all: black build install typing lint test
+
+black:
+	black -l 79 xyzspaces tests
+	isort -rc --atomic .
+
+build:
+	python3 -m pip install -r requirements.txt
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .mypy_cache
+	rm -fr .pytest_cache
+	find . -name '.ipynb_checkpoints' -exec rm -fr {} +
+
+dockerize:
+	jupyter-repo2docker --user-id 1000 --env XYZ_TOKEN=${XYZ_TOKEN} .
+
+install:
+	python3 -m pip install -e .
+
+typing:
+	pytest -v -s --mypy xyzspaces
+
+lint:
+	isort --check -rc --diff xyzspaces tests
+	flake8 -v --statistics --count .
+	black -l 79 --diff --check xyzspaces tests
+
+test:
+	pytest -v -s --cov=xyzspaces tests
+	coverage html