xplr 0.0.1__tar.gz

xplr-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 The Python Packaging Authority
+
+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.

xplr-0.0.1/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.5
+Name: xplr
+Version: 0.0.1
+Summary: Quick visualization of Python objects for exploratory data analysis
+Project-URL: Homepage, https://github.com/michaeldorman/xplr/
+Project-URL: Issues, https://github.com/michaeldorman/xplr/issues
+Author-email: Michael Dorman <dorman@post.bgu.ac.il>
+License: Copyright (c) 2026 The Python Packaging Authority
+        
+        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.
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# `xplr`
+
+[![badge](https://img.shields.io/pypi/v/xplr)](https://pypi.org/project/xplr/)
+
+## Overview
+
+The `xplr` package
+
+## Import on startup
+
+Create a startup script, such as `~/.python_startup.py`:
+
+```python
+from xplr import plot
+from xplr import view
+```
+
+For the script to be automatically executed on `python` startup, add this in your `.bashrc`:
+
+```python
+export PYTHONSTARTUP=~/.python_startup.py
+```
+
+In addition, for the script to be automatically executed on `ipython` startup, create ipython profiles (if you don't already have them):
+
+```python
+ipython profile create
+```
+
+Then, uncomment the following expression in `~/.ipython/profile_default/ipython_config.py`:
+
+```python
+c.InteractiveShellApp.exec_PYTHONSTARTUP = True
+```
+
+

xplr-0.0.1/README.md

@@ -0,0 +1,36 @@
+# `xplr`
+
+[![badge](https://img.shields.io/pypi/v/xplr)](https://pypi.org/project/xplr/)
+
+## Overview
+
+The `xplr` package
+
+## Import on startup
+
+Create a startup script, such as `~/.python_startup.py`:
+
+```python
+from xplr import plot
+from xplr import view
+```
+
+For the script to be automatically executed on `python` startup, add this in your `.bashrc`:
+
+```python
+export PYTHONSTARTUP=~/.python_startup.py
+```
+
+In addition, for the script to be automatically executed on `ipython` startup, create ipython profiles (if you don't already have them):
+
+```python
+ipython profile create
+```
+
+Then, uncomment the following expression in `~/.ipython/profile_default/ipython_config.py`:
+
+```python
+c.InteractiveShellApp.exec_PYTHONSTARTUP = True
+```
+
+

xplr-0.0.1/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = [
+    "hatchling >= 1.26",
+    "geopandas >= 1.1.0",
+    "rasterio >= 1.4.0",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "xplr"
+version = "0.0.1"
+authors = [
+  { name="Michael Dorman", email="dorman@post.bgu.ac.il" },
+]
+description = "Quick visualization of Python objects for exploratory data analysis"
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.license]
+file = "LICENSE"
+
+[project.urls]
+Homepage = "https://github.com/michaeldorman/xplr/"
+Issues = "https://github.com/michaeldorman/xplr/issues"

xplr-0.0.1/src/xplr/__init__.py

@@ -0,0 +1,2 @@
+from .xplr import plot
+from .xplr import view

xplr-0.0.1/src/xplr/xplr.py

@@ -0,0 +1,83 @@
+def open_file_with_default_app(file_path):
+    import os
+    import platform
+    import subprocess
+    """Opens a file using the operating system's default application."""
+    # Clean env
+    env = os.environ.copy()
+    for var in ['VIRTUAL_ENV', 'PYTHONHOME', 'PYTHONPATH']:
+        env.pop(var, None)
+    if 'VIRTUAL_ENV' in os.environ:
+        venv_bin = os.path.join(os.environ['VIRTUAL_ENV'], 'bin')
+        env['PATH'] = ':'.join(
+            p for p in env['PATH'].split(':') if p != venv_bin
+        )
+    # Run
+    current_os = platform.system().lower()
+    abs_path = os.path.abspath(file_path)
+    if current_os == 'windows':
+        os.startfile(abs_path)
+    elif current_os == 'darwin':
+        subprocess.call(('open', abs_path), stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
+    else:
+        subprocess.call(('xdg-open', abs_path), env=env, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
+
+def plot(x, *args, **kwargs):
+    import matplotlib.pyplot as plt
+    plt.ion()
+    import pandas as pd
+    import geopandas as gpd
+    import numpy as np
+    import rasterio.plot
+    # GeoDataFrame
+    if isinstance(x, gpd.GeoDataFrame):
+        x.plot(legend=True, *args, **kwargs)
+        return
+    # DataFrame
+    if isinstance(x, pd.DataFrame):
+        x.plot(*args, **kwargs)
+        return
+    # Series
+    if isinstance(x, pd.Series):
+        x.plot(*args, **kwargs)
+        return
+    # Array 1d
+    if isinstance(x, np.ndarray) and x.ndim == 1:
+        plt.plot(x, *args, **kwargs)
+        return
+    # Array 2d
+    if isinstance(x, np.ndarray) and x.ndim == 2:
+        plt.imshow(x, *args, **kwargs)
+        return
+
+def view(x) -> str:
+    import os
+    import subprocess
+    import tempfile
+    import pandas as pd
+    import geopandas as gpd
+    """
+    Exports an object to a temporary file and opens it in external program.
+
+    Args:
+        x: The object to view.
+
+    Returns:
+        The path to the temporary file (it persists until the OS cleans it up).
+    """
+    # Vector layer
+    if isinstance(x, gpd.GeoSeries) or isinstance(x, gpd.GeoDataFrame):
+        with tempfile.NamedTemporaryFile(suffix='.gpkg', delete=False) as tmp:
+            tmp_path = tmp.name
+        x.to_file(tmp_path, index=False)
+        open_file_with_default_app(tmp_path)
+        return tmp_path
+    # Table
+    if isinstance(x, pd.Series) or isinstance(x, pd.DataFrame):
+        with tempfile.NamedTemporaryFile(suffix='.xlsx', delete=False) as tmp:
+            tmp_path = tmp.name
+        x.to_excel(tmp_path, index=False)
+        open_file_with_default_app(tmp_path)
+        return tmp_path
+
+