n6sdk
n6sdk
: Server-side Software Development Kit for
n6
Basic References
Copyright, License and Authors
Tutorial
Setting up the development environment
Data processing and architecture overview
Data specification class
Implementing the data backend API
Custom authentication policy
Gluing it together
Installation for production (using Apache server)
Library Reference
Core modules
Helper modules
Release Notes
0.5.0 (2015-04-18)
0.4.0 (2014-12-23)
0.3.0 (2014-08-12)
0.2.0 (2014-08-08)
0.0.1 (2014-04-25)
n6sdk
Docs
»
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
X
_
_ErrorWithPublicMessageMixin (class in n6sdk.exceptions)
_KeyCleaningErrorMixin (class in n6sdk.exceptions)
_ValueCleaningErrorMixin (class in n6sdk.exceptions)
A
active (n6sdk.data_spec.DataSpec attribute)
address (n6sdk.data_spec.DataSpec attribute)
AddressField (class in n6sdk.data_spec.fields)
adip (n6sdk.data_spec.DataSpec attribute)
after_content() (n6sdk.pyramid_commons.renderers.BaseStreamRenderer method)
(n6sdk.pyramid_commons.renderers.StreamRenderer_json method)
(n6sdk.pyramid_commons.renderers.StreamRenderer_sjson method)
all_keys (n6sdk.data_spec.BaseDataSpec attribute)
all_param_keys (n6sdk.data_spec.BaseDataSpec attribute)
all_result_keys (n6sdk.data_spec.BaseDataSpec attribute)
allow_empty (n6sdk.data_spec.fields.ResultListFieldMixin attribute)
AnonymizedIPv4Field (class in n6sdk.data_spec.fields)
AnonymousAuthenticationPolicy (class in n6sdk.pyramid_commons)
as_unicode() (in module n6sdk.encoding_helpers)
ascii_str() (in module n6sdk.encoding_helpers)
AsciiMixIn (class in n6sdk.encoding_helpers)
asn (n6sdk.data_spec.DataSpec attribute)
ASNField (class in n6sdk.data_spec.fields)
attr_required() (in module n6sdk.class_helpers)
authenticated_userid() (n6sdk.pyramid_commons.AnonymousAuthenticationPolicy method)
(n6sdk.pyramid_commons.BaseAuthenticationPolicy method)
AuthorizationError
B
BaseAuthenticationPolicy (class in n6sdk.pyramid_commons)
BaseDataSpec (class in n6sdk.data_spec)
BaseStreamRenderer (class in n6sdk.pyramid_commons.renderers)
before_content() (n6sdk.pyramid_commons.renderers.BaseStreamRenderer method)
(n6sdk.pyramid_commons.renderers.StreamRenderer_json method)
break_on_result_cleaning_error (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
C
call_api() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
call_api_method() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
category (n6sdk.data_spec.DataSpec attribute)
CATEGORY_ENUMS (in module n6sdk.data_spec)
cc (n6sdk.data_spec.DataSpec attribute)
CC_SIMPLE_REGEX (in module n6sdk.regexes)
CCField (class in n6sdk.data_spec.fields)
checking_bytes_length (n6sdk.data_spec.fields.UnicodeLimitedField attribute)
clean_param_dict() (n6sdk.data_spec.BaseDataSpec method)
clean_param_keys() (n6sdk.data_spec.BaseDataSpec method)
clean_param_value() (n6sdk.data_spec.fields.DateTimeField method)
(n6sdk.data_spec.fields.DictResultField method)
(n6sdk.data_spec.fields.Field method)
(n6sdk.data_spec.fields.IPv4NetField method)
(n6sdk.data_spec.fields.IPv6Field method)
(n6sdk.data_spec.fields.IPv6NetField method)
(n6sdk.data_spec.fields.IntegerField method)
(n6sdk.data_spec.fields.UnicodeField method)
clean_result_dict() (n6sdk.data_spec.BaseDataSpec method)
clean_result_keys() (n6sdk.data_spec.BaseDataSpec method)
clean_result_value() (n6sdk.data_spec.fields.DateTimeField method)
(n6sdk.data_spec.fields.DictResultField method)
(n6sdk.data_spec.fields.Field method)
(n6sdk.data_spec.fields.IPv4NetField method)
(n6sdk.data_spec.fields.IPv6Field method)
(n6sdk.data_spec.fields.IPv6NetField method)
(n6sdk.data_spec.fields.IntegerField method)
(n6sdk.data_spec.fields.ResultListFieldMixin method)
(n6sdk.data_spec.fields.UnicodeField method)
complete() (n6sdk.pyramid_commons.ConfigHelper method)
concrete_view_class() (n6sdk.pyramid_commons.DefaultStreamViewBase class method)
confidence (n6sdk.data_spec.DataSpec attribute)
CONFIDENCE_ENUMS (in module n6sdk.data_spec)
ConfigHelper (class in n6sdk.pyramid_commons)
configure_views() (n6sdk.pyramid_commons.HttpResource method)
content_type (n6sdk.pyramid_commons.renderers.BaseStreamRenderer attribute)
(n6sdk.pyramid_commons.renderers.StreamRenderer_json attribute)
(n6sdk.pyramid_commons.renderers.StreamRenderer_sjson attribute)
copy() (n6sdk.data_spec.Ext method)
count (n6sdk.data_spec.DataSpec attribute)
D
data_backend_api_method (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
data_spec (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
DataAPIError
DataSpec (class in n6sdk.data_spec)
date_by_isoweekday() (in module n6sdk.datetime_helpers)
date_by_ordinalday() (in module n6sdk.datetime_helpers)
datetime_to_utc_timestamp() (in module n6sdk.datetime_helpers)
datetime_utc_normalize() (in module n6sdk.datetime_helpers)
DateTimeField (class in n6sdk.data_spec.fields)
decode_error_handling (n6sdk.data_spec.fields.UnicodeField attribute)
(n6sdk.data_spec.fields.URLSubstringField attribute)
default_public_message (n6sdk.exceptions._ErrorWithPublicMessageMixin attribute)
(n6sdk.exceptions.AuthorizationError attribute)
(n6sdk.exceptions.ParamCleaningError attribute)
(n6sdk.exceptions.ParamKeyCleaningError attribute)
(n6sdk.exceptions.ParamValueCleaningError attribute)
(n6sdk.exceptions.TooMuchDataError attribute)
default_root_factory (n6sdk.pyramid_commons.ConfigHelper attribute)
default_static_view_config (n6sdk.pyramid_commons.ConfigHelper attribute)
DefaultRootFactory (class in n6sdk.pyramid_commons)
DefaultStreamViewBase (class in n6sdk.pyramid_commons)
dict_with_nulls_removed() (in module n6sdk.pyramid_commons.renderers)
DictResultField (class in n6sdk.data_spec.fields)
dip (n6sdk.data_spec.DataSpec attribute)
DirField (class in n6sdk.data_spec.fields)
DOMAIN_ASCII_LOWERCASE_REGEX (in module n6sdk.regexes)
DOMAIN_ASCII_LOWERCASE_STRICT_REGEX (in module n6sdk.regexes)
DomainNameField (class in n6sdk.data_spec.fields)
DomainNameSubstringField (class in n6sdk.data_spec.fields)
dport (n6sdk.data_spec.DataSpec attribute)
dst() (n6sdk.datetime_helpers.FixedOffsetTimezone method)
E
effective_principals() (n6sdk.pyramid_commons.BaseAuthenticationPolicy method)
email (n6sdk.data_spec.DataSpec attribute)
EMAIL_SIMPLIFIED_REGEX (in module n6sdk.regexes)
EmailSimplifiedField (class in n6sdk.data_spec.fields)
encoding (n6sdk.data_spec.fields.UnicodeField attribute)
enum_values (n6sdk.data_spec.fields.DirField attribute)
(n6sdk.data_spec.fields.UnicodeEnumField attribute)
error_msg_template (n6sdk.data_spec.fields.AnonymizedIPv4Field attribute)
(n6sdk.data_spec.fields.ASNField attribute)
(n6sdk.data_spec.fields.CCField attribute)
(n6sdk.data_spec.fields.DomainNameField attribute)
(n6sdk.data_spec.fields.EmailSimplifiedField attribute)
(n6sdk.data_spec.fields.IBANSimplifiedField attribute)
(n6sdk.data_spec.fields.IPv4Field attribute)
(n6sdk.data_spec.fields.IPv4NetField attribute)
(n6sdk.data_spec.fields.IPv6Field attribute)
(n6sdk.data_spec.fields.IPv6NetField attribute)
(n6sdk.data_spec.fields.IntegerField attribute)
(n6sdk.data_spec.fields.PortField attribute)
(n6sdk.data_spec.fields.SourceField attribute)
(n6sdk.data_spec.fields.UnicodeRegexField attribute)
expires (n6sdk.data_spec.DataSpec attribute)
Ext (class in n6sdk.data_spec)
ExtendedAddressField (class in n6sdk.data_spec.fields)
F
Field (class in n6sdk.data_spec.fields)
FieldValueError
FieldValueTooLongError
FixedOffsetTimezone (class in n6sdk.datetime_helpers)
forget() (n6sdk.pyramid_commons.BaseAuthenticationPolicy method)
fqdn (n6sdk.data_spec.DataSpec attribute)
G
generate_content() (n6sdk.pyramid_commons.renderers.BaseStreamRenderer method)
get_adjusted_field() (n6sdk.data_spec.BaseDataSpec method)
get_auth_data() (n6sdk.pyramid_commons.AnonymousAuthenticationPolicy static method)
(n6sdk.pyramid_commons.BaseAuthenticationPolicy static method)
get_clean_param_dict_kwargs() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
get_clean_result_dict_kwargs() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
get_extra_api_kwargs() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
H
hash_algo_descr (n6sdk.data_spec.fields.HexDigestField attribute)
(n6sdk.data_spec.fields.MD5Field attribute)
(n6sdk.data_spec.fields.SHA1Field attribute)
HexDigestField (class in n6sdk.data_spec.fields)
HttpResource (class in n6sdk.pyramid_commons)
I
iban (n6sdk.data_spec.DataSpec attribute)
IBAN_REGEX (in module n6sdk.regexes)
IBANSimplifiedField (class in n6sdk.data_spec.fields)
id (n6sdk.data_spec.DataSpec attribute)
illegal_keys_msg_template (n6sdk.exceptions.ParamKeyCleaningError attribute)
injects (n6sdk.data_spec.DataSpec attribute)
IntegerField (class in n6sdk.data_spec.fields)
ip (n6sdk.data_spec.DataSpec attribute)
ip_network_as_tuple() (in module n6sdk.addr_helpers)
ip_network_tuple_to_min_max_ip() (in module n6sdk.addr_helpers)
IPv4_ANONYMIZED_REGEX (in module n6sdk.regexes)
IPv4_CIDR_NETWORK_REGEX (in module n6sdk.regexes)
IPv4_STRICT_DECIMAL_REGEX (in module n6sdk.regexes)
IPv4Field (class in n6sdk.data_spec.fields)
IPv4NetField (class in n6sdk.data_spec.fields)
ipv6 (n6sdk.data_spec.DataSpec attribute)
IPv6Field (class in n6sdk.data_spec.fields)
IPv6NetField (class in n6sdk.data_spec.fields)
is_datetime_format_normalized() (in module n6sdk.datetime_helpers)
iter_content() (n6sdk.pyramid_commons.renderers.BaseStreamRenderer method)
iter_deduplicated_params() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
K
key_to_subfield_factory (n6sdk.data_spec.fields.AddressField attribute)
(n6sdk.data_spec.fields.DictResultField attribute)
(n6sdk.data_spec.fields.ExtendedAddressField attribute)
L
ListOfDictsField (class in n6sdk.data_spec.fields)
M
make_config() (n6sdk.pyramid_commons.ConfigHelper method)
make_data_backend_api() (n6sdk.pyramid_commons.ConfigHelper method)
make_extended_field() (n6sdk.data_spec.Ext method)
make_wsgi_app() (n6sdk.pyramid_commons.ConfigHelper method)
max_length (n6sdk.data_spec.fields.AnonymizedIPv4Field attribute)
(n6sdk.data_spec.fields.CCField attribute)
(n6sdk.data_spec.fields.DomainNameSubstringField attribute)
(n6sdk.data_spec.fields.EmailSimplifiedField attribute)
(n6sdk.data_spec.fields.IBANSimplifiedField attribute)
(n6sdk.data_spec.fields.IPv4Field attribute)
(n6sdk.data_spec.fields.IPv4NetField attribute)
(n6sdk.data_spec.fields.IPv6Field attribute)
(n6sdk.data_spec.fields.IPv6NetField attribute)
(n6sdk.data_spec.fields.SourceField attribute)
(n6sdk.data_spec.fields.URLSubstringField attribute)
(n6sdk.data_spec.fields.UnicodeLimitedField attribute)
max_value (n6sdk.data_spec.fields.ASNField attribute)
(n6sdk.data_spec.fields.IntegerField attribute)
(n6sdk.data_spec.fields.PortField attribute)
md5 (n6sdk.data_spec.DataSpec attribute)
MD5Field (class in n6sdk.data_spec.fields)
min_value (n6sdk.data_spec.fields.ASNField attribute)
(n6sdk.data_spec.fields.IntegerField attribute)
(n6sdk.data_spec.fields.PortField attribute)
missing_keys_msg_template (n6sdk.exceptions.ParamKeyCleaningError attribute)
modified (n6sdk.data_spec.DataSpec attribute)
msg_template (n6sdk.exceptions.ParamValueCleaningError attribute)
N
n6sdk.addr_helpers (module)
n6sdk.class_helpers (module)
n6sdk.data_spec (module)
n6sdk.data_spec.fields (module)
n6sdk.datetime_helpers (module)
n6sdk.encoding_helpers (module)
n6sdk.exceptions (module)
n6sdk.pyramid_commons (module)
n6sdk.pyramid_commons.renderers (module)
n6sdk.regexes (module)
name (n6sdk.data_spec.DataSpec attribute)
nondestructive_update() (n6sdk.data_spec.Ext method)
num_of_characters (n6sdk.data_spec.fields.HexDigestField attribute)
(n6sdk.data_spec.fields.MD5Field attribute)
(n6sdk.data_spec.fields.SHA1Field attribute)
O
origin (n6sdk.data_spec.DataSpec attribute)
ORIGIN_ENUMS (in module n6sdk.data_spec)
P
param_field_specs() (n6sdk.data_spec.BaseDataSpec method)
ParamCleaningError
ParamKeyCleaningError
ParamValueCleaningError
parse_iso_date() (in module n6sdk.datetime_helpers)
parse_iso_datetime() (in module n6sdk.datetime_helpers)
parse_iso_datetime_to_utc() (in module n6sdk.datetime_helpers)
parse_iso_time() (in module n6sdk.datetime_helpers)
parse_python_formatted_datetime() (in module n6sdk.datetime_helpers)
phone (n6sdk.data_spec.DataSpec attribute)
PortField (class in n6sdk.data_spec.fields)
prepare_config() (n6sdk.pyramid_commons.ConfigHelper method)
prepare_params() (n6sdk.pyramid_commons.DefaultStreamViewBase method)
prepare_settings() (n6sdk.pyramid_commons.ConfigHelper method)
proto (n6sdk.data_spec.DataSpec attribute)
PROTO_ENUMS (in module n6sdk.data_spec)
provide_surrogateescape() (in module n6sdk.encoding_helpers)
public_message (n6sdk.exceptions._ErrorWithPublicMessageMixin attribute)
R
regex (n6sdk.data_spec.fields.AnonymizedIPv4Field attribute)
(n6sdk.data_spec.fields.CCField attribute)
(n6sdk.data_spec.fields.DomainNameField attribute)
(n6sdk.data_spec.fields.EmailSimplifiedField attribute)
(n6sdk.data_spec.fields.IBANSimplifiedField attribute)
(n6sdk.data_spec.fields.IPv4Field attribute)
(n6sdk.data_spec.fields.IPv4NetField attribute)
(n6sdk.data_spec.fields.SourceField attribute)
(n6sdk.data_spec.fields.UnicodeRegexField attribute)
register_stream_renderer() (in module n6sdk.pyramid_commons)
registrar (n6sdk.data_spec.DataSpec attribute)
remember() (n6sdk.pyramid_commons.BaseAuthenticationPolicy method)
render_content() (n6sdk.pyramid_commons.renderers.BaseStreamRenderer method)
(n6sdk.pyramid_commons.renderers.StreamRenderer_json method)
(n6sdk.pyramid_commons.renderers.StreamRenderer_sjson method)
renderer_name (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
renderers (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
replaces (n6sdk.data_spec.DataSpec attribute)
resource_id (n6sdk.pyramid_commons.DefaultStreamViewBase attribute)
restriction (n6sdk.data_spec.DataSpec attribute)
RESTRICTION_ENUMS (in module n6sdk.data_spec)
result_field_specs() (n6sdk.data_spec.BaseDataSpec method)
ResultCleaningError
ResultKeyCleaningError
ResultListFieldMixin (class in n6sdk.data_spec.fields)
ResultValueCleaningError
S
sha1 (n6sdk.data_spec.DataSpec attribute)
SHA1Field (class in n6sdk.data_spec.fields)
singleton() (in module n6sdk.class_helpers)
source (n6sdk.data_spec.DataSpec attribute)
SourceField (class in n6sdk.data_spec.fields)
sport (n6sdk.data_spec.DataSpec attribute)
status (n6sdk.data_spec.DataSpec attribute)
STATUS_ENUMS (in module n6sdk.data_spec)
StreamRenderer_json (class in n6sdk.pyramid_commons.renderers)
StreamRenderer_sjson (class in n6sdk.pyramid_commons.renderers)
StreamResponse (class in n6sdk.pyramid_commons)
T
target (n6sdk.data_spec.DataSpec attribute)
time (n6sdk.data_spec.DataSpec attribute)
TooMuchDataError
tzname() (n6sdk.datetime_helpers.FixedOffsetTimezone method)
U
unauthenticated_userid() (n6sdk.pyramid_commons.AnonymousAuthenticationPolicy method)
(n6sdk.pyramid_commons.BaseAuthenticationPolicy method)
UnicodeEnumField (class in n6sdk.data_spec.fields)
UnicodeField (class in n6sdk.data_spec.fields)
UnicodeLimitedField (class in n6sdk.data_spec.fields)
UnicodeRegexField (class in n6sdk.data_spec.fields)
until (n6sdk.data_spec.DataSpec attribute)
url (n6sdk.data_spec.DataSpec attribute)
url_pattern (n6sdk.data_spec.DataSpec attribute)
URLField (class in n6sdk.data_spec.fields)
URLSubstringField (class in n6sdk.data_spec.fields)
username (n6sdk.data_spec.DataSpec attribute)
utcoffset() (n6sdk.datetime_helpers.FixedOffsetTimezone method)
X
x509fp_sha1 (n6sdk.data_spec.DataSpec attribute)
Read the Docs
v: v0.5.0
Versions
latest
v0.5.0
v0.4.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.