Ship rerun package inside of a rerun_sdk folder (rerun-io#1085)

* Ship rerun package inside of a rerun_sdk folder

.mypy.ini

@@ -1,5 +1,5 @@
 [mypy]
-files = rerun_py/rerun, rerun_py/tests, examples
+files = rerun_py/rerun_sdk/rerun, rerun_py/tests, examples
 exclude = examples/objectron/dataset/proto
 namespace_packages = True
 show_error_codes = True

rerun_py/Cargo.toml

@@ -65,4 +65,4 @@ pyo3-build-config = "0.18.0"
 toml = "0.7"
 
 [package.metadata.maturin]
-name = "rerun.rerun_bindings"
+name = "rerun_bindings"

rerun_py/docs/gen_common_index.py

@@ -68,7 +68,7 @@
 ]
 
 # Virual folder where we will generate the md files
-root = Path(__file__).parent.parent.resolve()
+root = Path(__file__).parent.parent.joinpath("rerun_sdk").resolve()
 common_dir = Path("common")
 
 # We use griffe to access docstrings

rerun_py/docs/gen_package_index.py

@@ -35,7 +35,7 @@
 
 import mkdocs_gen_files
 
-root = Path(__file__).parent.parent.resolve()
+root = Path(__file__).parent.parent.joinpath("rerun_sdk").resolve()
 package_dir = Path("package")
 
 nav = mkdocs_gen_files.Nav()

rerun_py/mkdocs.yml

@@ -22,7 +22,7 @@ plugins:
       custom_templates: rerun_py/docs/templates # Override the function template. NOTE: relative to working directory. (https://github.com/mkdocstrings/mkdocstrings/issues/477)
       handlers:
         python:
-          paths: ["."] # Lookup python modules relative to this path
+          paths: ["rerun_sdk"] # Lookup python modules relative to this path
           import: # Cross-references for python and numpy
             - https://docs.python.org/3/objects.inv
             - https://numpy.org/doc/stable/objects.inv

rerun_py/pyproject.toml

@@ -40,4 +40,10 @@ line-length = 120
 target-version = ["py38"]
 
 [tool.maturin]
+# We use a python package from inside the rerun_sdk folder to avoid conflicting
+# with the other `rerun` pypi package. The rerun_sdk.pth adds this to the pythonpath
+# which then allows `import rerun` to work as expected.
+# See https://github.com/rerun-io/rerun/pull/1085 for more details
+include = ["rerun_sdk.pth"]
 locked = true
+python-packages = ["rerun_sdk/rerun"]