Skip to content

Commit 7b2c38f

Browse files
ksquarekumarksquarekumar
committed
ci: create release for v1.0.4+deps
1 parent 369c252 commit 7b2c38f

24 files changed

Lines changed: 1288 additions & 1 deletion

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ dmypy.json
131131
node_modules
132132
/assets/
133133

134-
dash_extensions/*
135134
inst/*
136135
**/file_system_backend/*
137136
man/*

‎PKG-INFO‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Metadata-Version: 2.1
2+
Name: dash-extensions
3+
Version: 1.0.4+deps
4+
Summary: Extensions for Plotly Dash.
5+
Home-page: https://dash-extensions.com
6+
License: MIT
7+
Author: emher
8+
Author-email: emil.h.eriksen@gmail.com
9+
Requires-Python: >=3.8,<4
10+
Classifier: License :: OSI Approved :: MIT License
11+
Classifier: Programming Language :: Python :: 3
12+
Classifier: Programming Language :: Python :: 3.8
13+
Classifier: Programming Language :: Python :: 3.9
14+
Classifier: Programming Language :: Python :: 3.10
15+
Classifier: Programming Language :: Python :: 3.11
16+
Provides-Extra: mantine
17+
Requires-Dist: Flask-Caching (>=2.0.2)
18+
Requires-Dist: dash (>=2.9.3)
19+
Requires-Dist: dash-mantine-components (>=0.11.1) ; extra == "mantine"
20+
Requires-Dist: dataclass-wizard (>=0.22.2,<0.23.0)
21+
Requires-Dist: jsbeautifier (>=1.14.9,<2.0.0)
22+
Requires-Dist: more-itertools (>=8.0.0)
23+
Project-URL: Repository, https://github.com/thedirtyfew/dash-extensions
24+
Description-Content-Type: text/markdown
25+
26+
[![PyPI Latest Release](https://img.shields.io/pypi/v/dash-extensions.svg)](https://pypi.org/project/dash-extensions/)
27+
[![codecov](https://img.shields.io/codecov/c/github/thedirtyfew/dash-extensions?logo=codecov)](https://codecov.io/gh/thedirtyfew/dash-extensions)
28+
[![Testing](https://github.com/thedirtyfew/dash-extensions/actions/workflows/python-test.yml/badge.svg)](https://github.com/thedirtyfew/dash-extensions/actions/workflows/python-test.yml)
29+
[![CodeQL](https://github.com/thedirtyfew/dash-extensions/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/thedirtyfew/dash-extensions/actions/workflows/codeql-analysis.yml)
30+
31+
The `dash-extensions` package is a collection of utility functions, syntax extensions, and Dash components that aim to improve the Dash development experience. It can be divided in four main pillars,
32+
33+
* The `enrich` module, which contains various enriched versions of Dash components
34+
* A number of custom components, e.g. the `Websocket` component, which enables real-time communication and push notifications
35+
* The `javascript` module, which contains functionality to ease the interplay between Dash and JavaScript
36+
* The `snippets` module, which contains a collection of utility functions (documentation limited to source code comments)
37+
38+
The `enrich` module enables a number of _transforms_ that add functionality and/or syntactic sugar to Dash. Examples include
39+
40+
* Making it possible to avoid invoking a callback _if it is already running_ via the `BlockingCallbackTransform`
41+
* Enabling logging from within Dash callbacks via the `LogTransform`
42+
* Improving app performance via the `ServersideOutputTransform`
43+
44+
to name a few. To enable interactivity, the documentation has been moved to a [separate page](http://dash-extensions.com).
45+
46+
NB: The 1.0.0 version introduces a number of breaking changes, see documentation for details.
47+
48+
## Donation
49+
50+
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=Z9RXT5HVPK3B8&currency_code=DKK&source=url)
51+
52+
## Installing
53+
54+
* Only `release/{VERSION}` branches and `v{VERSION}` tags should be used for direct pip / poetry based install(s), installation(s) from branches that were not created by the `release` action will not work as they will be missing all the `webpack` generated files.
55+

‎dash_extensions/BeforeAfter.py‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class BeforeAfter(Component):
7+
"""A BeforeAfter component.
8+
Before After Image Slider based on https://github.com/sneas/img-comparison-slider
9+
10+
Keyword arguments:
11+
12+
- id (string; optional):
13+
The ID used to identify this component in Dash callbacks.
14+
15+
- after (dict; optional):
16+
Props for the `after` Img component. eg {\"src\":
17+
\"/assets/lena_color.png\"}.
18+
19+
- before (dict; optional):
20+
Props for the `before` Img component. eg {\"src\":
21+
\"/assets/lena_bw.png\"}.
22+
23+
- direction (a value equal to: 'horizontal', 'vertical'; default 'horizontal'):
24+
Set slider direction.
25+
26+
- height (string; default 'auto'):
27+
Image height - default \"auto\" for responsive images.
28+
29+
- hover (boolean; default True):
30+
Automatic slide on mouse over.
31+
32+
- keyboard (a value equal to: 'enabled', 'disabled'; default 'enabled'):
33+
Enable/disable slider position control with the keyboard.
34+
35+
- value (number; default 50):
36+
The divider position can be specified as a percentage, i.e. 0 to
37+
100.
38+
39+
- width (string; default '100%'):
40+
Image width - default \"100%\" for responsive images."""
41+
_children_props = []
42+
_base_nodes = ['children']
43+
_namespace = 'dash_extensions'
44+
_type = 'BeforeAfter'
45+
@_explicitize_args
46+
def __init__(self, id=Component.UNDEFINED, height=Component.UNDEFINED, width=Component.UNDEFINED, hover=Component.UNDEFINED, value=Component.UNDEFINED, direction=Component.UNDEFINED, keyboard=Component.UNDEFINED, before=Component.UNDEFINED, after=Component.UNDEFINED, **kwargs):
47+
self._prop_names = ['id', 'after', 'before', 'direction', 'height', 'hover', 'keyboard', 'value', 'width']
48+
self._valid_wildcard_attributes = []
49+
self.available_properties = ['id', 'after', 'before', 'direction', 'height', 'hover', 'keyboard', 'value', 'width']
50+
self.available_wildcard_properties = []
51+
_explicit_args = kwargs.pop('_explicit_args')
52+
_locals = locals()
53+
_locals.update(kwargs) # For wildcard attrs and excess named props
54+
args = {k: _locals[k] for k in _explicit_args}
55+
56+
super(BeforeAfter, self).__init__(**args)

‎dash_extensions/CycleBreaker.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class CycleBreaker(Component):
7+
"""A CycleBreaker component.
8+
Simple data store that automatically copies the current value of the src property into dst property. Can be used to break circular dependencies.
9+
10+
Keyword arguments:
11+
12+
- id (string; optional):
13+
The ID used to identify this component in Dash callbacks.
14+
15+
- dst (boolean | number | string | dict | list; optional):
16+
Read the forwarded value from this property.
17+
18+
- src (boolean | number | string | dict | list; optional):
19+
Set this property to value to be forwarded from ."""
20+
_children_props = []
21+
_base_nodes = ['children']
22+
_namespace = 'dash_extensions'
23+
_type = 'CycleBreaker'
24+
@_explicitize_args
25+
def __init__(self, id=Component.UNDEFINED, src=Component.UNDEFINED, dst=Component.UNDEFINED, **kwargs):
26+
self._prop_names = ['id', 'dst', 'src']
27+
self._valid_wildcard_attributes = []
28+
self.available_properties = ['id', 'dst', 'src']
29+
self.available_wildcard_properties = []
30+
_explicit_args = kwargs.pop('_explicit_args')
31+
_locals = locals()
32+
_locals.update(kwargs) # For wildcard attrs and excess named props
33+
args = {k: _locals[k] for k in _explicit_args}
34+
35+
super(CycleBreaker, self).__init__(**args)

‎dash_extensions/DeferScript.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class DeferScript(Component):
7+
"""A DeferScript component.
8+
Used to delay import of js resources until after React had been loaded. Typically used to apply js to dynamic
9+
content. Based on https://github.com/Grasia/grasia-dash-components/blob/master/src/components/Import.react.js
10+
11+
Keyword arguments:
12+
13+
- id (string; optional):
14+
The ID used to identify this component in Dash callbacks.
15+
16+
- src (string; optional):
17+
Local or external source of the javascript to import."""
18+
_children_props = []
19+
_base_nodes = ['children']
20+
_namespace = 'dash_extensions'
21+
_type = 'DeferScript'
22+
@_explicitize_args
23+
def __init__(self, id=Component.UNDEFINED, src=Component.UNDEFINED, **kwargs):
24+
self._prop_names = ['id', 'src']
25+
self._valid_wildcard_attributes = []
26+
self.available_properties = ['id', 'src']
27+
self.available_wildcard_properties = []
28+
_explicit_args = kwargs.pop('_explicit_args')
29+
_locals = locals()
30+
_locals.update(kwargs) # For wildcard attrs and excess named props
31+
args = {k: _locals[k] for k in _explicit_args}
32+
33+
super(DeferScript, self).__init__(**args)

‎dash_extensions/EventListener.py‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class EventListener(Component):
7+
"""An EventListener component.
8+
The EventListener component listens for events from the document object or children if provided.
9+
10+
Keyword arguments:
11+
12+
- children (a list of or a singular dash component, string or number; optional):
13+
The children of this component. If any children are provided, the
14+
component will listen for events from these components. If no
15+
children are specified, the component will listen for events from
16+
the document object.
17+
18+
- id (string; optional):
19+
The ID used to identify this component in Dash callbacks.
20+
21+
- className (string; optional):
22+
A custom class name.
23+
24+
- event (dict; optional):
25+
The latest event fired.
26+
27+
- events (list of dicts; default [{"event": "keydown", "props": ["key", "altKey", "ctrlKey", "shiftKey","metaKey", "repeat"]}]):
28+
The event entry specifies which event to listen to, e.g. \"click\"
29+
for click events. The \"props\" entry specifies what event
30+
properties to record, e.g. [\"x\", \"y\"] to get the cursor
31+
position.
32+
33+
`events` is a list of dicts with keys:
34+
35+
- event (string; optional)
36+
37+
- props (list of strings; optional)
38+
39+
- logging (boolean; default False):
40+
If True, event information is logged to the javascript console.
41+
Useful if you can't remember events props.
42+
43+
- n_events (number; default 0):
44+
The number of events fired.
45+
46+
- style (dict; optional):
47+
The CSS style of the component."""
48+
_children_props = []
49+
_base_nodes = ['children']
50+
_namespace = 'dash_extensions'
51+
_type = 'EventListener'
52+
@_explicitize_args
53+
def __init__(self, children=None, id=Component.UNDEFINED, events=Component.UNDEFINED, logging=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, event=Component.UNDEFINED, n_events=Component.UNDEFINED, **kwargs):
54+
self._prop_names = ['children', 'id', 'className', 'event', 'events', 'logging', 'n_events', 'style']
55+
self._valid_wildcard_attributes = []
56+
self.available_properties = ['children', 'id', 'className', 'event', 'events', 'logging', 'n_events', 'style']
57+
self.available_wildcard_properties = []
58+
_explicit_args = kwargs.pop('_explicit_args')
59+
_locals = locals()
60+
_locals.update(kwargs) # For wildcard attrs and excess named props
61+
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
62+
63+
super(EventListener, self).__init__(children=children, **args)

‎dash_extensions/EventSource.py‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class EventSource(Component):
7+
"""An EventSource component.
8+
An interface to server sent events in Dash
9+
10+
Keyword arguments:
11+
12+
- id (string; optional):
13+
The ID used to identify this component in Dash callbacks.
14+
15+
- close (boolean; optional):
16+
Close event source.
17+
18+
- error (string; optional):
19+
Error.
20+
21+
- message (string; optional):
22+
Received message.
23+
24+
- readyState (number; optional):
25+
A number representing the state of the connection. Possible values
26+
are CONNECTING (0), OPEN (1), or CLOSED (2).
27+
28+
- url (string; required):
29+
A DOMString representing the URL of the source.
30+
31+
- withCredentials (boolean; optional):
32+
A boolean value indicating whether the EventSource object was
33+
instantiated with cross-origin (CORS) credentials set (True), or
34+
not (False, the default)."""
35+
_children_props = []
36+
_base_nodes = ['children']
37+
_namespace = 'dash_extensions'
38+
_type = 'EventSource'
39+
@_explicitize_args
40+
def __init__(self, id=Component.UNDEFINED, close=Component.UNDEFINED, error=Component.UNDEFINED, message=Component.UNDEFINED, readyState=Component.UNDEFINED, withCredentials=Component.UNDEFINED, url=Component.REQUIRED, **kwargs):
41+
self._prop_names = ['id', 'close', 'error', 'message', 'readyState', 'url', 'withCredentials']
42+
self._valid_wildcard_attributes = []
43+
self.available_properties = ['id', 'close', 'error', 'message', 'readyState', 'url', 'withCredentials']
44+
self.available_wildcard_properties = []
45+
_explicit_args = kwargs.pop('_explicit_args')
46+
_locals = locals()
47+
_locals.update(kwargs) # For wildcard attrs and excess named props
48+
args = {k: _locals[k] for k in _explicit_args}
49+
50+
for k in ['url']:
51+
if k not in args:
52+
raise TypeError(
53+
'Required argument `' + k + '` was not specified.')
54+
55+
super(EventSource, self).__init__(**args)

‎dash_extensions/Lottie.py‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# AUTO GENERATED FILE - DO NOT EDIT
2+
3+
from dash.development.base_component import Component, _explicitize_args
4+
5+
6+
class Lottie(Component):
7+
"""A Lottie component.
8+
9+
10+
Keyword arguments:
11+
12+
- children (a list of or a singular dash component, string or number; optional):
13+
The children of this component.
14+
15+
- id (string; optional):
16+
The ID used to identify this component in Dash callbacks.
17+
18+
- ariaLabel (string; optional)
19+
20+
- ariaRole (string; optional)
21+
22+
- className (string; optional):
23+
The class of the component.
24+
25+
- direction (number; optional)
26+
27+
- height (string; optional):
28+
Pixel value for containers height.
29+
30+
- isClickToPauseDisabled (boolean; optional)
31+
32+
- isPaused (boolean; optional)
33+
34+
- isStopped (boolean; optional)
35+
36+
- options (dict; optional):
37+
Options passed to the Lottie animation (see
38+
https://www.npmjs.com/package/react-lottie for details).
39+
40+
- segments (list of numbers; optional)
41+
42+
- speed (number; optional)
43+
44+
- style (string; optional)
45+
46+
- title (string; optional)
47+
48+
- url (string; optional):
49+
If set, data will be downloaded from this url.
50+
51+
- width (string; optional):
52+
Pixel value for containers width."""
53+
_children_props = []
54+
_base_nodes = ['children']
55+
_namespace = 'dash_extensions'
56+
_type = 'Lottie'
57+
@_explicitize_args
58+
def __init__(self, children=None, id=Component.UNDEFINED, className=Component.UNDEFINED, options=Component.UNDEFINED, url=Component.UNDEFINED, width=Component.UNDEFINED, height=Component.UNDEFINED, isStopped=Component.UNDEFINED, isPaused=Component.UNDEFINED, speed=Component.UNDEFINED, segments=Component.UNDEFINED, direction=Component.UNDEFINED, ariaRole=Component.UNDEFINED, ariaLabel=Component.UNDEFINED, isClickToPauseDisabled=Component.UNDEFINED, title=Component.UNDEFINED, style=Component.UNDEFINED, **kwargs):
59+
self._prop_names = ['children', 'id', 'ariaLabel', 'ariaRole', 'className', 'direction', 'height', 'isClickToPauseDisabled', 'isPaused', 'isStopped', 'options', 'segments', 'speed', 'style', 'title', 'url', 'width']
60+
self._valid_wildcard_attributes = []
61+
self.available_properties = ['children', 'id', 'ariaLabel', 'ariaRole', 'className', 'direction', 'height', 'isClickToPauseDisabled', 'isPaused', 'isStopped', 'options', 'segments', 'speed', 'style', 'title', 'url', 'width']
62+
self.available_wildcard_properties = []
63+
_explicit_args = kwargs.pop('_explicit_args')
64+
_locals = locals()
65+
_locals.update(kwargs) # For wildcard attrs and excess named props
66+
args = {k: _locals[k] for k in _explicit_args if k != 'children'}
67+
68+
super(Lottie, self).__init__(children=children, **args)

0 commit comments

Comments
 (0)