syd 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

syd-0.1.6.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: syd
+Version: 0.1.6
+Summary: A Python package for making GUIs for data science easy.
+Project-URL: Homepage, https://github.com/landoskape/syd
+Author-email: Andrew Landau <andrew+tyler+landau+getridofthisanddtheplusses@gmail.com>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: data-science,gui,interactive,jupyter,machine-learning,notebook,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: ipywidgets
+Requires-Dist: matplotlib
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# syd
+
+[![PyPI version](https://badge.fury.io/py/syd.svg)](https://badge.fury.io/py/syd)
+[![Tests](https://github.com/landoskape/syd/actions/workflows/tests.yml/badge.svg)](https://github.com/landoskape/syd/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/shareyourdata/badge/?version=stable)](https://shareyourdata.readthedocs.io/en/stable/?badge=stable)
+[![codecov](https://codecov.io/gh/landoskape/syd/branch/main/graph/badge.svg)](https://codecov.io/gh/landoskape/syd)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+A package to help you share your data!
+
+Have you ever wanted to look through all your data really quickly interactively? Of course you have. Mo data mo problems, but only if you don't know what to do with it. And that starts with looking at your data. And that's why syd stands for show your data! 
+
+Syd is a system for creating a data viewing GUI that you can view on a web-browser. And guess what? Since it opens on a web browser, you can even open it on any other computer on your local network! For example, your PI. Gone are the days of single random examples that they make infinitely stubborn conclusions about. Now, you can look at all the examples, quickly and easily, on their computer. And that's why syd stands for share your data!
+
+Okay, so what is it? Syd is an automated system to convert some basic python plotting code into an interactive GUI. This is great, because it means you only have to think about what you want to plot and what you want to be interactive, syd does the work to make an interface. There's some small overhead for learning how to prepare your data to work with syd, but we provide some templates to make it easy. You know what that means? That means you get to focus on _thinking_ about your data, rather than spending time writing code to look at it. And that's why syd stands for Science, Yes! Datum!
+
+## Installation
+
+```bash
+pip install syd
+```
+
+## Quick Start
+Right now the only way to use it is in a jupyter notebook. More deployments coming soon!
+This is an example of a sine wave viewer which is about as simple as it gets. 
+```python
+# In a notebook! 
+import matplotlib.pyplot as plt
+import numpy as np
+from syd import make_viewer
+def plot(viewer, state):
+    fig, ax = plt.subplots()
+    x = np.linspace(0, 10, 1000)
+    y = state['amplitude'] * np.sin(state['frequency'] * x)
+    ax.plot(x, y)
+    return fig
+        
+viewer = make_viewer()
+viewer.set_plot(plot)
+viewer.add_float('amplitude', value=1.0, min_value=0, max_value=2)
+viewer.add_float('frequency', value=1.0, min_value=0.1, max_value=5)
+viewer.deploy(continuous=True)
+```
+
+We have several examples of more complex viewers in the [examples](examples) folder. A good one
+to start with is the [first example](examples/first_example.ipynb) because this has detailed 
+explanations of how to use the core elements of SYD. To see what the exact same viewer looks like
+when written as a class, see the [subclass example](examples/subclass_example.ipynb). This format
+is pretty useful when you want complex functionality - for example if you want to add extra
+supporting methods for processing data and updating parameters that require more complex logic.
+
+## Documentation
+
+Full documentation is available at [shareyourdata.readthedocs.io](https://shareyourdata.readthedocs.io/).
+
+Key features:
+- Create interactive matplotlib visualizations with minimal code
+- Support for various parameter types (sliders, dropdowns, checkboxes, etc.)
+- Real-time updates as parameters change
+- Works in Jupyter notebooks and can be shared over local network
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Here's how you can help:
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Run the tests (`pytest`)
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request online
+
+Please make sure to update tests as appropriate and adhere to the existing coding style.

syd-0.1.6.dist-info/RECORD

@@ -0,0 +1,18 @@
+syd/__init__.py,sha256=elTyYXUlIX5Vv8AFjhM5C_XeZtU83YeGq_W980duI6k,284
+syd/interactive_viewer.py,sha256=2vEyRwq4dxzGbJOz3UymNw_RJXRHrzv7UbJ2CV6q1bI,53950
+syd/parameters.py,sha256=DbjevWsbIoVqlS3bYkqRd6SXJ054iexoNFj4VBss2eA,47703
+syd/flask_deployment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syd/flask_deployment/components.py,sha256=I5xTFX5ho6EZ8ZjxknlluzSsxP5atUBAi_k7b8p_9Os,17391
+syd/flask_deployment/deployer.py,sha256=EOo-oT3duBwWxVpQdpe-pXmAGGzfnqk4EY-vNcN-vAI,11288
+syd/flask_deployment/static/css/styles.css,sha256=0zBjzquFMcxTNYNmVP1KdS3_7c1WiMYEqYHvubUyRhU,514
+syd/flask_deployment/static/js/components.js,sha256=o_Ty-fvFsXTSl0eavJDDqhhxi-N3nuB-IPXkmin4vvI,1563
+syd/flask_deployment/static/js/viewer.js,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syd/flask_deployment/templates/base.html,sha256=6WZ9-Pc6pAysQbBSg_rihfRXPHMwyFxVR8YYD5bL524,783
+syd/flask_deployment/templates/viewer.html,sha256=AoCdWQ5TIUEnpi6fjWdWUO9XJSLGFH0fHggGZd87yeg,2813
+syd/notebook_deployment/__init__.py,sha256=eRum4_pXLTtaoUWvVnVCxJFrLM8Nn8EQ0yLwE9puh-w,41
+syd/notebook_deployment/deployer.py,sha256=7iQ5kzs2VIkItmHbPpxtWdSRkGth5OABqyATc5WtbgI,8739
+syd/notebook_deployment/widgets.py,sha256=bBBBJtgzfYcoXdhkuF4Du7HNXwwPjj_shGDhy3VoWs8,17446
+syd-0.1.6.dist-info/METADATA,sha256=N7-fVmqKWzwJhhgl6t-Gft9BAlnhUpcTG9eni1Zs9Dk,5412
+syd-0.1.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+syd-0.1.6.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
+syd-0.1.6.dist-info/RECORD,,

syd/notebook_deploy.py

@@ -1,277 +0,0 @@
-from typing import Dict, Any, Tuple
-import matplotlib.pyplot as plt
-import ipywidgets as widgets
-from IPython.display import display
-from .parameters import (
-    Parameter,
-    TextParameter,
-    SingleSelectionParameter,
-    MultipleSelectionParameter,
-    BooleanParameter,
-    IntegerParameter,
-    FloatParameter,
-    IntegerPairParameter,
-    FloatPairParameter,
-)
-from .interactive_viewer import InteractiveViewer
-
-
-class NotebookDeployment:
-    """
-    Deployment system for InteractiveViewer in Jupyter notebooks using ipywidgets.
-    Includes enhanced layout control and figure size management.
-    """
-
-    def __init__(self, viewer: InteractiveViewer, figsize: Tuple[float, float] = (8, 6), controls_width: float = 30, continuous=False):
-        """Initialize with an InteractiveViewer instance."""
-        self.viewer = viewer
-        self.widgets: Dict[str, widgets.Widget] = {}
-        self._widget_callbacks = {}
-        self._current_figure = None
-
-        # Default figure size
-        self.fig_width = figsize[0]
-        self.fig_height = figsize[1]
-        self.controls_width = controls_width
-        self.continuous = continuous
-
-    def _create_text_widget(self, param: TextParameter) -> widgets.Text:
-        """Create a text input widget."""
-        w = widgets.Text(value=param.default, description=param.name, layout=widgets.Layout(width="95%"), style={"description_width": "initial"})
-        return w
-
-    def _create_selection_widget(self, param: SingleSelectionParameter) -> widgets.Dropdown:
-        """Create a dropdown selection widget."""
-        w = widgets.Dropdown(
-            options=param.options,
-            value=param.default if param.default else param.options[0],
-            description=param.name,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-        return w
-
-    def _create_multiple_selection_widget(self, param: MultipleSelectionParameter) -> widgets.SelectMultiple:
-        """Create a multiple selection widget."""
-        w = widgets.SelectMultiple(
-            options=param.options,
-            value=param.default if param.default else [],
-            description=param.name,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-        return w
-
-    def _create_boolean_widget(self, param: BooleanParameter) -> widgets.Checkbox:
-        """Create a checkbox widget."""
-        w = widgets.Checkbox(value=param.default, description=param.name, layout=widgets.Layout(width="95%"), style={"description_width": "initial"})
-        return w
-
-    def _create_integer_widget(self, param: IntegerParameter) -> widgets.IntSlider:
-        """Create an integer slider widget."""
-        w = widgets.IntSlider(
-            value=param.default if param.default is not None else param.min_value,
-            min=param.min_value,
-            max=param.max_value,
-            description=param.name,
-            continuous_update=self.continuous,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-        return w
-
-    def _create_float_widget(self, param: FloatParameter) -> widgets.FloatSlider:
-        """Create a float slider widget."""
-        w = widgets.FloatSlider(
-            value=param.default if param.default is not None else param.min_value,
-            min=param.min_value,
-            max=param.max_value,
-            step=param.step,
-            description=param.name,
-            continuous_update=self.continuous,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-        return w
-
-    def _create_integer_pair_widget(self, param: IntegerPairParameter) -> widgets.HBox:
-        """Create a pair of integer input widgets."""
-        low = widgets.IntText(
-            value=param.default[0],
-            description=f"{param.name} (low)",
-            layout=widgets.Layout(width="47%"),
-            style={"description_width": "initial"},
-        )
-        high = widgets.IntText(
-            value=param.default[1],
-            description=f"{param.name} (high)",
-            layout=widgets.Layout(width="47%"),
-            style={"description_width": "initial"},
-        )
-        return widgets.HBox([low, high], layout=widgets.Layout(width="95%"))
-
-    def _create_float_pair_widget(self, param: FloatPairParameter) -> widgets.HBox:
-        """Create a pair of float input widgets."""
-        low = widgets.FloatText(
-            value=param.default[0],
-            description=f"{param.name} (low)",
-            layout=widgets.Layout(width="47%"),
-            style={"description_width": "initial"},
-        )
-        high = widgets.FloatText(
-            value=param.default[1],
-            description=f"{param.name} (high)",
-            layout=widgets.Layout(width="47%"),
-            style={"description_width": "initial"},
-        )
-        return widgets.HBox([low, high], layout=widgets.Layout(width="95%"))
-
-    def _create_widget_for_parameter(self, param: Parameter) -> widgets.Widget:
-        """Create the appropriate widget based on parameter type."""
-        widget_creators = {
-            TextParameter: self._create_text_widget,
-            SingleSelectionParameter: self._create_selection_widget,
-            MultipleSelectionParameter: self._create_multiple_selection_widget,
-            BooleanParameter: self._create_boolean_widget,
-            IntegerParameter: self._create_integer_widget,
-            FloatParameter: self._create_float_widget,
-            IntegerPairParameter: self._create_integer_pair_widget,
-            FloatPairParameter: self._create_float_pair_widget,
-        }
-
-        creator = widget_creators.get(type(param))
-        if not creator:
-            raise ValueError(f"Unsupported parameter type: {type(param)}")
-
-        return creator(param)
-
-    def _create_size_controls(self) -> widgets.VBox:
-        """Create controls for adjusting the figure size."""
-        self.width_slider = widgets.FloatSlider(
-            value=self.fig_width,
-            min=4,
-            max=20,
-            step=0.5,
-            description="Figure Width",
-            continuous_update=True,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-
-        self.height_slider = widgets.FloatSlider(
-            value=self.fig_height,
-            min=3,
-            max=15,
-            step=0.5,
-            description="Figure Height",
-            continuous_update=True,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-
-        self.container_width = widgets.IntSlider(
-            value=30,
-            min=20,
-            max=80,
-            description="Controls Width %",
-            continuous_update=True,
-            layout=widgets.Layout(width="95%"),
-            style={"description_width": "initial"},
-        )
-
-        # Add callbacks for size changes
-        self.width_slider.observe(self._handle_size_change, names="value")
-        self.height_slider.observe(self._handle_size_change, names="value")
-        self.container_width.observe(self._handle_container_width_change, names="value")
-
-        return widgets.VBox(
-            [widgets.HTML("<b>Layout Controls</b>"), self.width_slider, self.height_slider, self.container_width],
-            layout=widgets.Layout(margin="10px 0px"),
-        )
-
-    def _handle_size_change(self, change: Dict[str, Any]) -> None:
-        """Handle changes to figure size."""
-        self.fig_width = self.width_slider.value
-        self.fig_height = self.height_slider.value
-        self._update_plot()
-
-    def _handle_container_width_change(self, change: Dict[str, Any]) -> None:
-        """Handle changes to container widths."""
-        controls_width = f"{self.container_width.value}%"
-        plot_width = f"{100 - self.container_width.value}%"
-
-        self.widgets_container.layout.width = controls_width
-        self.plot_container.layout.width = plot_width
-
-    def _handle_widget_change(self, name: str, change: Dict[str, Any]) -> None:
-        """Handle widget value changes and update the viewer parameter."""
-        if isinstance(self.widgets[name], widgets.HBox):
-            # Handle pair widgets
-            low_value = self.widgets[name].children[0].value
-            high_value = self.widgets[name].children[1].value
-            value = (low_value, high_value)
-        else:
-            value = change["new"]
-
-        self.viewer.set_parameter_value(name, value)
-        self._update_plot()
-
-    def _update_plot(self) -> None:
-        """Update the plot with current parameters and size."""
-        self._current_fig.clear()
-        self._current_fig.set_size_inches(self.fig_width, self.fig_height)
-        self._current_fig = self.viewer.plot(fig=self._current_fig, state=self.viewer.get_state())
-
-        # Apply tight layout to remove dead space
-        self._current_fig.tight_layout()
-
-        self.plot_output.clear_output(wait=True)
-        with self.plot_output:
-            display(self._current_fig)
-
-    def create_widgets(self) -> None:
-        """Create widgets for all parameters in the viewer."""
-        for name, param in self.viewer.parameters.items():
-            widget = self._create_widget_for_parameter(param)
-            self.widgets[name] = widget
-
-            # Set up callback
-            if isinstance(widget, widgets.HBox):
-                # For pair widgets, observe both components
-                widget.children[0].observe(lambda change, n=name: self._handle_widget_change(n, change), names="value")
-                widget.children[1].observe(lambda change, n=name: self._handle_widget_change(n, change), names="value")
-            else:
-                widget.observe(lambda change, n=name: self._handle_widget_change(n, change), names="value")
-
-    def display_widgets(self) -> None:
-        """Display all widgets and plot in an organized layout."""
-        # Create size controls
-        size_controls = self._create_size_controls()
-
-        # Create widgets container with parameters and size controls
-        all_widgets = list(self.widgets.values()) + [size_controls]
-        self.widgets_container = widgets.VBox(all_widgets, layout=widgets.Layout(width="30%", padding="10px", overflow_y="auto"))
-
-        # Create output widget for plot
-        self.plot_output = widgets.Output()
-        self.plot_container = widgets.VBox([self.plot_output], layout=widgets.Layout(width="70%", padding="10px"))
-
-        # Combine widgets and plot in layout
-        # Make the container height dynamic
-        layout = widgets.HBox(
-            [self.widgets_container, self.plot_container], layout=widgets.Layout(width="100%", height="auto")  # Dynamic height based on content
-        )
-        display(layout)
-
-        # Create initial plot
-        self._current_fig = plt.figure(figsize=(self.fig_width, self.fig_height))
-        plt.close(self._current_fig)  # close the figure to prevent it from being displayed
-        self._current_fig = self.viewer.plot(fig=self._current_fig, state=self.viewer.get_state())
-        with self.plot_output:
-            display(self._current_fig)
-
-    def deploy(self) -> None:
-        """Create and display all widgets with proper deployment state management."""
-        with self.viewer.deploy_app():
-            self.create_widgets()
-            self.display_widgets()

syd-0.1.4.dist-info/METADATA

@@ -1,33 +0,0 @@
-Metadata-Version: 2.4
-Name: syd
-Version: 0.1.4
-Summary: A Python package for making GUIs for data science easy.
-Project-URL: Homepage, https://github.com/landoskape/syd
-Author-email: Andrew Landau <andrew+tyler+landau+getridofthisanddtheplusses@gmail.com>
-License-Expression: GPL-3.0-or-later
-License-File: LICENSE
-Keywords: data-science,gui,interactive,jupyter,machine-learning,notebook,python
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
-Provides-Extra: test
-Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
-Requires-Dist: pytest>=7.0.0; extra == 'test'
-Description-Content-Type: text/markdown
-
-# syd
- A package to help you share your data!
-
-Have you ever wanted to look through all your data really quickly interactively? Of course you have. Mo data mo problems, but only if you don't know what to do with it. And that starts with looking at your data. And that's why syd stands for show your data! 
-
-Syd is a system for creating a data viewing GUI that you can view on a web-browser. And guess what? Since it opens on a web browser, you can even open it on any other computer on your local network! For example, your PI. Gone are the days of single random examples that they make infinitely stubborn conclusions about. Now, you can look at all the examples, quickly and easily, on their computer. And that's why syd stands for share your data!
-
-Okay, so what is it? Syd is an automated system to convert some basic python plotting code into an interactive GUI. This is great, because it means you only have to think about what you want to plot and what you want to be interactive, syd does the work to make an interface. There's some small overhead for learning how to prepare your data to work with syd, but we provide some templates to make it easy. You know what that means? That means you get to focus on _thinking_ about your data, rather than spending time writing code to look at it. And that's why syd stands for Science, Yes! Datum!

syd-0.1.4.dist-info/RECORD

@@ -1,8 +0,0 @@
-syd/__init__.py,sha256=Wzf5T3NBDfhQoTnhnRNHSlAsE0XMqbclXG-M81Vas70,22
-syd/interactive_viewer.py,sha256=33aFY6Q4vg6fP5QVs2RYqfnqmFJzML-Lcnhbb1XwN2g,9353
-syd/notebook_deploy.py,sha256=k7yq7Noq30IlCbMXZ1rrX8oW5a3nxLNJHDFGvoJMYxg,11472
-syd/parameters.py,sha256=oQSAGM2D2Db4YLzj_nQb6_vPp18ltld7qvFC138lRJw,9885
-syd-0.1.4.dist-info/METADATA,sha256=re0-a0zHTlvEMyJIAHf7AM-OVEQkohwes7K2-xWfy_0,2449
-syd-0.1.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-syd-0.1.4.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
-syd-0.1.4.dist-info/RECORD,,