syd 1.2.6__py3-none-any.whl → 1.2.7__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
syd/__init__.py CHANGED
@@ -1,4 +1,4 @@
1
- __version__ = "1.2.6"
1
+ __version__ = "1.2.7"
2
2
 
3
3
  from .viewer import make_viewer, Viewer
4
4
  from .support import show_open_servers, close_servers
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: syd
3
- Version: 1.2.6
3
+ Version: 1.2.7
4
4
  Summary: A Python package for making GUIs for data science easy.
5
5
  Project-URL: Homepage, https://github.com/landoskape/syd
6
6
  Author-email: Andrew Landau <andrew+tyler+landau+getridofthisanddtheplusses@gmail.com>
@@ -36,6 +36,7 @@ Description-Content-Type: text/markdown
36
36
  [![Documentation Status](https://readthedocs.org/projects/shareyourdata/badge/?version=stable)](https://shareyourdata.readthedocs.io/en/stable/?badge=stable)
37
37
  [![codecov](https://codecov.io/gh/landoskape/syd/branch/main/graph/badge.svg)](https://codecov.io/gh/landoskape/syd)
38
38
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
39
+ [![DOI](https://joss.theoj.org/papers/10.21105/joss.08447/status.svg)](https://doi.org/10.21105/joss.08447)
39
40
 
40
41
 
41
42
  <div>
@@ -59,6 +60,8 @@ pip install syd
59
60
  ## Documentation
60
61
  The full documentation is available [here](https://shareyourdata.readthedocs.io/). It includes a quick start guide, a comprehensive tutorial, and an API reference for the different elements of Syd. If you have any questions or want to suggest improvements to the docs, please let us know on the [github issues page](https://github.com/landoskape/syd/issues)!
61
62
 
63
+ **For AI agents/LLMs:** A comprehensive skills file ([SKILLS.md](./SKILLS.md)) is available with workflow patterns, parameter reference tables, common gotchas, and best practices for using Syd in other projects.
64
+
62
65
  ## Quick Start
63
66
  This is an example of a sine wave viewer which is about as simple as it gets. You can choose where you want to display the viewer. If you use ``viewer.show()`` then the GUI will deploy as the output of a jupyter cell (this only works in jupyter or colab!). If you use ``viewer.share()`` then the GUI will open a page in your default web browser and you can interact with the data there (works in jupyter notebooks and also from python scripts!).
64
67
 
@@ -234,16 +237,8 @@ pip install black
234
237
  black . # from the root directory of the repo
235
238
  ```
236
239
 
237
- ## To-Do List
238
- This section doubles as a checklist for things I think could be useful and _a place to get feedback about what users think is useful_. If you think something in this is critical and should be prioritized, or if you think something is missing, please let me know by submitting an issue on the [github issues page](https://github.com/landoskape/syd/issues).
239
- - Layout controls
240
- - [ ] Add a "save" button that saves the current state of the viewer to a json file
241
- - [ ] Add a "load" button that loads the viewer state from a json file
242
- - [ ] Add a "freeze" button that allows the user to update state variables without updating the plot until unfreezing
243
- - [ ] Add a window for capturing any error messages that might be thrown by the plot function. Maybe we could have a little interface for looking at each one (up to a point) and the user could press a button to throw an error for the traceback.
244
- - [ ] Consider "app_deployed" context for each deployer...
245
- - Export options:
246
- - [ ] Export lite: export the viewer as a HTML/Java package that contains an incomplete set of renderings of figures -- using a certain set of parameters.
247
- - [ ] Export full: export the viewer in a way that contains the data to give full functionality.
248
- - [ ] Idea for sharing: https://github.com/analyticalmonk/awesome-neuroscience, https://github.com/fasouto/awesome-dataviz
249
- - [ ] The handling of value in Selection parameters is kind of weird.... I think we need to think more about what to do for fails!!!!
240
+ ## Citing this package
241
+ If you use this package, let us know! It's made to help the community so we're happy to hear about how this has helped (or any suggestions!).
242
+ If you publish anything that depended on Syd, we'd appreciate if you cite the JOSS paper:
243
+
244
+ Landau, A., (2025). Syd: A package for making interactive data visualizations in python. Journal of Open Source Software, 10(112), 8447, https://doi.org/10.21105/joss.08447
@@ -1,4 +1,4 @@
1
- syd/__init__.py,sha256=Yt5zZh7xZGBEthWRjdA1_BKGx0v12I5uwmbtltY6WXs,117
1
+ syd/__init__.py,sha256=hoV3gG0bfgVPJIcsuSVdhxXEmSzQs9krtv_dLye_9gM,117
2
2
  syd/parameters.py,sha256=lzCHSMGYEdQ_FMbcXnntdPF1XvCm7fybB6CNy3TFn04,43543
3
3
  syd/support.py,sha256=LoHOsTN0byyDxk9uibjM0BKnI-vAJ4aU-tWILMCXz1Y,6783
4
4
  syd/viewer.py,sha256=U0TzAKDyORZ3KkNIq5HTCJqLJkD1hP7ua3Cr8KYZUOg,55383
@@ -22,7 +22,7 @@ syd/flask_deployment/templates/index.html,sha256=KDMR-KTMpdQa1PS8py71-NSoGMAWE3q
22
22
  syd/notebook_deployment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
23
23
  syd/notebook_deployment/deployer.py,sha256=ovuFvj5_qXB5WToNhCxrEHmPuKYypIeLqrUg0KjovQs,12706
24
24
  syd/notebook_deployment/widgets.py,sha256=ptys7exVA6NCF4eCRZMTPJblT0ZbtPdN4o2A0Yh5Cfc,20781
25
- syd-1.2.6.dist-info/METADATA,sha256=lpnEeFJAEkn-mhdHmSXYLEUuQX9liGydartk_bqpwJw,16329
26
- syd-1.2.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
27
- syd-1.2.6.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
28
- syd-1.2.6.dist-info/RECORD,,
25
+ syd-1.2.7.dist-info/METADATA,sha256=dZ4kQaFrEsDTM-rwC3I5iSc3mBuGaVolyVLt7fbN0QU,15576
26
+ syd-1.2.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
27
+ syd-1.2.7.dist-info/licenses/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
28
+ syd-1.2.7.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.27.0
2
+ Generator: hatchling 1.28.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any