eve_panel package

Submodules

eve_panel.auth module

auth module

Authentication and Authorization handling

class eve_panel.auth.AuthSelector(**params)

Bases: eve_panel.auth.EveAuthBase

Allows selecting from available authentication schemes

Attributes

token

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_headers()	Generate auth headers for HTTP requests.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
login()	perform any actions required to aquire credentials.
message(**kwargs)	Inspect .param.message method for the full docstring
panel()	Get the panel representation of this object for GUI
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
set_token(token)	Set the access token manually.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

auth_view
set_auth_by_name

auth_options = {'Basic': EveBasicAuth(name='EveBasicAuth00005', password='', token=b'', username=''), 'Bearer': EveBearerAuth(name='EveBearerAuth00006', token='')}

auth_view()

get_headers()

Generate auth headers for HTTP requests.

Returns

Auth related headers to be included in all requests.

Return type

dict

login()

perform any actions required to aquire credentials.

Returns

whether login was successful

Return type

bool

name = 'AuthSelector'

panel()

Get the panel representation of this object for GUI

Returns

GUI widgets with impotant inputs

and feedback for the auth scheme

Return type

panel.Viewable

set_auth_by_name(name)

property token

class eve_panel.auth.EveAuthBase(**params)

Bases: param.parameterized.Parameterized

Base class for Eve authentication scheme

Inheritance:

param.Parameterized:

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_headers()	Generate auth headers for HTTP requests.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
login()	perform any actions required to aquire credentials.
message(**kwargs)	Inspect .param.message method for the full docstring
panel()	Get the panel representation of this object for GUI
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
set_token(token)	Set the access token manually.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

get_headers()

Generate auth headers for HTTP requests.

Returns

Auth related headers to be included in all requests.

Return type

dict

login()

perform any actions required to aquire credentials.

Returns

whether login was successful

Return type

bool

name = 'EveAuthBase'

panel()

Get the panel representation of this object for GUI

Returns

GUI widgets with impotant inputs

and feedback for the auth scheme

Return type

panel.Viewable

set_token(token)

Set the access token manually.

Parameters

token ([type]) – [description]

class eve_panel.auth.EveBasicAuth(**params)

Bases: eve_panel.auth.EveAuthBase

Support for eve basic auth.

Inheritance:

EveAuthBase:

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_headers()	Generate auth headers for HTTP requests.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
login()	perform any actions required to aquire credentials.
message(**kwargs)	Inspect .param.message method for the full docstring
panel()	Get the panel representation of this object for GUI
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
set_token(token)	Set the access token manually.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

get_headers()

Generate auth headers for HTTP requests.

Returns

Auth related headers to be included in all requests.

Return type

dict

login()

perform any actions required to aquire credentials.

Returns

whether login was successful

Return type

bool

name = 'EveBasicAuth'

panel()

Get the panel representation of this object for GUI

Returns

GUI widgets with impotant inputs

and feedback for the auth scheme

Return type

panel.Viewable

password = ''

token = b''

username = ''

class eve_panel.auth.EveBearerAuth(**params)

Bases: eve_panel.auth.EveAuthBase

Support for Eve bearer auth.

Inheritance:

EveAuthBase:

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_headers()	Generate auth headers for HTTP requests.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
login()	perform any actions required to aquire credentials.
message(**kwargs)	Inspect .param.message method for the full docstring
panel()	Get the panel representation of this object for GUI
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
set_token(token)	Set the access token manually.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

get_headers()

Generate auth headers for HTTP requests.

Returns

Auth related headers to be included in all requests.

Return type

dict

login()

perform any actions required to aquire credentials.

Returns

whether login was successful

Return type

bool

name = 'EveBearerAuth'

panel()

Get the panel representation of this object for GUI

Returns

GUI widgets with impotant inputs

and feedback for the auth scheme

Return type

panel.Viewable

token = ''

eve_panel.domain module

domain module

Tools to create a client for an Eve domain.

class eve_panel.domain.EveDomain(name=String)

Bases: eve_panel.eve_model.EveModelBase

Attributes

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clone
from_domain_def
make_panel
panel
servable
set_token
show

classmethod from_domain_def(domain_def, domain_name='EveApp', http_client=None, sort_by_url=False)

make_panel(show_client=True, tabs_location='above')

name = 'EveDomain'

set_token(token)

eve_panel.eve_client module

Eve client

Client for single or multiple Eve APIs.

class eve_panel.eve_client.EveClient(name=String)

Bases: eve_panel.eve_model.EveModelBase

Attributes

domains

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clone
from_app_settings_dict
from_apps_dict
make_panel
panel
servable
show

property domains

classmethod from_app_settings_dict(settings_dict: dict, sort_by_url=False, name='EveClient', http_client_class=<class 'eve_panel.http_client.EveHttpxClient'>, **kwargs)

classmethod from_apps_dict(apps: dict, name='EveClient', sort_by_url=False, http_client_class=<class 'eve_panel.http_client.EveHttpxClient'>, **kwargs)

make_panel(show_client=False)

name = 'EveClient'

eve_panel.eve_model module

Eve model

Base classes for objects that represent Eve models.

class eve_panel.eve_model.DefaultLayout(*objects, **params)

Bases: panel.layout.grid.GridBox

Attributes

aspect_ratio

background

css_classes

height

max_height

max_width

min_height

min_width

nrows

sizing_mode

Methods

add_periodic_callback(callback[, period, …])	Schedules a periodic callback to be run at an interval set by the period.
app([notebook_url, port])	Displays a bokeh server app inline in the notebook.
append(obj)	Appends an object to the layout.
clear()	Clears the objects on this layout.
clone(*objects, **params)	Makes a copy of the layout sharing the same parameters.
controls([parameters, jslink])	Creates a set of widgets which allow manipulating the parameters on this instance.
debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
embed([max_states, max_opts, json, …])	Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model.
extend(objects)	Extends the objects on this layout with a list.
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_root([doc, comm, preprocess])	Returns the root model and applies pre-processing hooks
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
insert(index, obj)	Inserts an object in the layout at the specified index.
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
jscallback([args])	Allows defining a JS callback to be triggered when a property changes on the source object.
jslink(target[, code, args, bidirectional])	Links properties on the source object to those on the target object in JS code.
link(target[, callbacks, bidirectional])	Links the parameters on this object to attributes on another object in Python.
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pop(index)	Pops an item from the layout by index.
pprint()	Prints a compositional repr of the class.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
remove(obj)	Removes an object from the layout.
reverse()	Reverses the objects in the layout.
save(filename[, title, resources, template, …])	Saves Panel objects to file.
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
select([selector])	Iterates over the Viewable and any potential children in the applying the Selector.
servable([title, location])	Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. :param title: A string title to give the Document (if served as an app) :type title: str :param location: Whether to create a Location component to observe and set the URL location. :type location: boolean or panel.io.location.Location.
server_doc([doc, title, location])	Returns a serveable bokeh Document with the panel attached
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
show([title, port, address, …])	Starts a Bokeh server and displays the Viewable in a new tab.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

name = 'DefaultLayout'

ncols = 3

width = 720

class eve_panel.eve_model.EveModelBase(name=String)

Bases: param.parameterized.Parameterized

Attributes

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clone
make_panel
panel
servable
show

clone(**kwargs)

property gui

make_panel()

name = 'EveModelBase'

panel()

servable()

show()

eve_panel.field module

eve_panel.field.EveField(name, schema, klass)

eve_panel.http_client module

eve_panel.http_client.DEFAULT_HTTP_CLIENT

alias of eve_panel.http_client.EveHttpxClient

class eve_panel.http_client.EveHttpClient(**params)

Bases: eve_panel.eve_model.EveModelBase

Base class for an http client

Attributes

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

busy_indicator
clone
delete
get
make_panel
panel
patch
post
put
servable
show

busy_indicator()

delete(url, etag, timeout=10)

get(url, timeout=10, **params)

name = 'EveHttpClient'

patch(url, data, etag=None, timeout=10)

post(url, data='', json={}, timeout=10)

put(url, data, etag=None, timeout=10)

class eve_panel.http_client.EveHttpxClient(**params)

Bases: eve_panel.http_client.EveHttpClient

Attributes

app

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

busy_indicator
clear_messages
clone
delete
from_app_settings
get
headers
log_error
make_panel
messages
panel
patch
post
put
servable
set_token
show

property app

auth = AuthSelector(_auth_object=EveBasicAuth(name='EveBasicAuth00008', password='', token=b'', username=''), name='AuthSelector00007')

clear_messages()

delete(url, etag='', timeout=10)

classmethod from_app_settings(settings, urls=None)

get(url, timeout=10, **params)

headers()

log_error(e)

make_panel()

messages()

name = 'EveHttpxClient'

patch(url, data, etag=None, timeout=10)

post(url, data='', json={}, timeout=10)

put(url, data, etag=None, timeout=10)

server_url = 'http://localhost:5000'

server_urls = []

set_token(token)

eve_panel.item module

class eve_panel.item.EveItem(name=String)

Bases: eve_panel.eve_model.EveModelBase

Attributes

gui

url

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

buttons
clone
delete
from_schema
items
keys
make_panel
panel
patch
pull
push
save
servable
show
to_dict
to_record
values
version
version_diffs
versions

buttons()

clone()

delete(verification=None)

classmethod from_schema(name, schema, resource_url, http_client=None, data={})

items()

keys()

make_panel()

name = 'EveItem'

patch(fields)

pull()

push()

save()

to_dict()

to_record()

property url

values()

version(version)

version_diffs()

versions()

eve_panel.page module

class eve_panel.page.EvePage(name=String)

Bases: eve_panel.eve_model.EveModelBase

Attributes

df

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clone
items
json_view
keys
make_panel
panel
pull
push
records
servable
show
table_view
to_dataframe
to_records
values
widgets_view

property df

items()

json_view()

keys()

name = 'EvePage'

panel()

pull(names=None, version=1)

push(names=None)

records()

table_view()

to_dataframe()

to_records()

values()

widgets_view()

class eve_panel.page.EvePageCache(name=String)

Bases: param.parameterized.Parameterized

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

get
items
keys
values

get(key, fallback=None)

items()

keys()

name = 'EvePageCache'

values()

class eve_panel.page.PageZero(name=String)

Bases: eve_panel.page.EvePage

Attributes

df

gui

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clone
items
json_view
keys
make_panel
panel
pull
push
records
servable
show
table_view
to_dataframe
to_records
values
widgets_view

json_view()

name = 'PageZero'

panel()

table_view()

widgets_view()

eve_panel.resource module

class eve_panel.resource.EveResource(**params)

Bases: eve_panel.eve_model.EveModelBase

Interface for an Eve resource. Should be instantiated using an Eve resource definition:

EveResource.from_resource_def(definition, name)

Inheritance:

EveModelBase:

Attributes

df

gui

projection

Methods

debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
find([query, projection, max_results, …])	Find documents in the remote resource that match a mongodb query.
find_df([query, projection, max_results, …])	Same as find() only returns a pandas dataframe
find_page([query, projection, max_results, …])	Same as find() only returns an EvePage instance
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
from_resource_def(resource_def, resource_name)	Generate a resource interface from a Eve resource definition.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
insert_documents(docs[, validate])	Insert documents into the database
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
make_item(**kwargs)	Generate EveItem from key value pairs
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint([imports, prefix, unknown_value, …])	(Experimental) Pretty printed representation that may be evaluated with eval.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
read_file([f, ext])	Read file into the upload buffer.
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

clear_cache
clear_upload_buffer
clone
current_page
current_page_view
decrement_page
filter
filter_docs
find_one
find_one_item
flush_buffer
get_page
get_page_df
get_page_records
increment_page
items
keys
make_panel
new_item
next_page
pages
panel
post
previous_page
project
pull
pull_page
push
push_page
read_clipboard
records
reload_page
remove_item
servable
show
to_dataframe
to_records
upload_errors_view
upload_view
validate_documents
values

clear_cache()

clear_upload_buffer()

columns = []

current_page()

current_page_view()

decrement_page()

property df

filter(**filters)

filter_docs(docs)

filters = {}

find(query={}, projection={}, max_results=25, page_number=1)

Find documents in the remote resource that match a mongodb query.

Parameters

• query (dict, optional) – Mongo query. Defaults to {}.

• projection (dict, optional) – Mongo projection. Defaults to {}.

• max_results (int, optional) – Items per page. Defaults to 25.

• page_number (int, optional) – page to return if query returns more than max_results. Defaults to 1.

Returns

requested page documents that match query

Return type

list

find_df(query={}, projection={}, max_results=25, page_number=1)

Same as find() only returns a pandas dataframe

Parameters

• query (dict, optional) – [description]. Defaults to {}.

• projection (dict, optional) – [description]. Defaults to {}.

• max_results (int, optional) – [description]. Defaults to 25.

• page_number (int, optional) – [description]. Defaults to 1.

Returns

[description]

Return type

[type]

find_one(query: dict = {}, projection: dict = {})

find_one_item(query={}, projection={})

find_page(query={}, projection={}, max_results=25, page_number=1)

Same as find() only returns an EvePage instance

Parameters

• query (dict, optional) – [description]. Defaults to {}.

• projection (dict, optional) – [description]. Defaults to {}.

• max_results (int, optional) – [description]. Defaults to 25.

• page_number (int, optional) – [description]. Defaults to 1.

Returns

requested page from all items that match the query

Return type

EvePage

flush_buffer()

classmethod from_resource_def(resource_def: dict, resource_name: str, http_client: eve_panel.http_client.EveHttpClient = None)

Generate a resource interface from a Eve resource definition.

Parameters

• resource_def (dict) – Eve resource definition

• resource_name (str) – Name to use for this resource

• http_client (EveHttpClient, optional) – http client to use. Defaults to None.

Returns

Interface to the remote resource.

Return type

EveResource

get_page(idx)

get_page_df(idx)

get_page_records(idx)

property gui

increment_page()

insert_documents(docs: Union[list, tuple, dict], validate=True) → tuple

Insert documents into the database

Parameters

• docs (list) – Documents to insert.

• validate (bool, optional) – whether to validate schema of docs locally. Defaults to True.

Raises

TypeError – raised if docs is not the correct type.

Returns

Successfuly inserted, rejected, rejection reasons.

Return type

tuple[list, list, list]

items()

items_per_page = 10

keys()

make_item(**kwargs)

Generate EveItem from key value pairs

Returns

EveItem instance that enforces schema of current resource.

Return type

EveItem

make_panel(show_client=True, tabs_location='above')

name = 'EveResource'

new_item(data={})

next_page()

page_number = 0

pages(start=1, end=None)

post(docs)

previous_page()

project(**projection)

property projection

pull(start=1, end=None)

pull_page(idx=0)

push(idxs=None)

push_page(idx)

read_clipboard()

read_file(f: BinaryIO = None, ext: str = 'csv')

Read file into the upload buffer.

Parameters

• f (File, optional) – file like object. Defaults to None.

• ext (str, optional) – file extension. Defaults to “csv”.

Returns

documents read

Return type

list

records()

reload_page(page_number=None)

remove_item(_id: str) → bool

selection = []

to_dataframe()

to_records()

upload_errors = []

upload_errors_view()

upload_view()

validate_documents(docs)

values()

eve_panel.settings module

eve_panel.types module

class eve_panel.types.CoerceClassSelector(class_, default=None, instantiate=True, is_instance=True, **params)

Bases: param.ClassSelector

Parameter allowing selection of either a subclass or an instance of a given set of classes. By default, requires an instance, but if is_instance=False, accepts a class instead. Both class and instance values respect the instantiate slot, though it matters only for is_instance=True.

Attributes

allow_None

class_

constant

default

doc

instantiate

is_instance

label

name

owner

per_instance

pickle_default_value

precedence

readonly

watchers

Methods

deserialize(value)	Given a serializable Python value, return a value that the parameter can be set to
get_range()	Return the possible types for this parameter’s value.
serialize(value)	Given the parameter value, return a Python value suitable for serialization

schema

eve_panel.types.bytes_param(**kwargs)

eve_panel.types.objectid_param(**kwargs)

eve_panel.types.set_param(**kwargs)

eve_panel.utils module

eve_panel.utils.from_app_config(name, config, address='http://localhost:5000')

eve_panel.widgets module

eve_panel.widgets.LiteralSchemaInput(name, schema, type_=None)

class eve_panel.widgets.LiteralSchemaInputBase(**params)

Bases: panel.widgets.input.LiteralInput

[summary]

Parameters

LiteralInput ([type]) – [description]

Attributes

aspect_ratio

background

css_classes

height

max_height

max_width

min_height

min_width

sizing_mode

type

value

width

Methods

add_periodic_callback(callback[, period, …])	Schedules a periodic callback to be run at an interval set by the period.
app([notebook_url, port])	Displays a bokeh server app inline in the notebook.
clone(**params)	Makes a copy of the object sharing the same parameters.
controls([parameters, jslink])	Creates a set of widgets which allow manipulating the parameters on this instance.
debug(**kwargs)	Inspect .param.debug method for the full docstring
defaults(**kwargs)	Inspect .param.defaults method for the full docstring
embed([max_states, max_opts, json, …])	Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model.
force_new_dynamic_value(**kwargs)	Inspect .param.force_new_dynamic_value method for the full docstring
from_param(parameter, **params)	Construct a widget from a Parameter and link the two bi-directionally.
get_param_values(**kwargs)	Inspect .param.get_param_values method for the full docstring
get_root([doc, comm, preprocess])	Returns the root model and applies pre-processing hooks
get_value_generator(**kwargs)	Inspect .param.get_value_generator method for the full docstring
inspect_value(**kwargs)	Inspect .param.inspect_value method for the full docstring
jscallback([args])	Allows defining a JS callback to be triggered when a property changes on the source object.
jslink(target[, code, args, bidirectional])	Links properties on the source object to those on the target object in JS code.
link(target[, callbacks, bidirectional])	Links the parameters on this object to attributes on another object in Python.
message(**kwargs)	Inspect .param.message method for the full docstring
params(**kwargs)	Inspect .param.params method for the full docstring
pprint()	Prints a compositional repr of the class.
print_param_defaults(*args, **kwargs)	Inspect .param.print_param_defaults method for the full docstring
print_param_values(**kwargs)	Inspect .param.print_param_values method for the full docstring
save(filename[, title, resources, template, …])	Saves Panel objects to file.
script_repr([imports, prefix])	Variant of __repr__ designed for generating a runnable script.
select([selector])	Iterates over the Viewable and any potential children in the applying the Selector.
servable([title, location])	Serves the object if in a panel serve context and returns the Panel object to allow it to display itself in a notebook context. :param title: A string title to give the Document (if served as an app) :type title: str :param location: Whether to create a Location component to observe and set the URL location. :type location: boolean or panel.io.location.Location.
server_doc([doc, title, location])	Returns a serveable bokeh Document with the panel attached
set_default(*args, **kwargs)	Inspect .param.set_default method for the full docstring
set_dynamic_time_fn(**kwargs)	Inspect .param.set_dynamic_time_fn method for the full docstring
set_param(**kwargs)	Inspect .param.set_param method for the full docstring
show([title, port, address, …])	Starts a Bokeh server and displays the Viewable in a new tab.
state_pop()	Restore the most recently saved state.
state_push()	Save this instance’s state.
verbose(**kwargs)	Inspect .param.verbose method for the full docstring
warning(**kwargs)	Inspect .param.warning method for the full docstring

validate_schema

name = 'LiteralSchemaInputBase'

validate_schema(value)

eve_panel.widgets.get_widget(name, schema)

Module contents

Eve-panel.

A marriage between Eve and Panel.

Example:

Todo:

eve_panel.notebook()

Load notebook support.