0.4.1_1_g1dbffb3
ourobori
description
structure
details about module ourobori.apps.dependencies.dbs
details about module ourobori.apps.dependencies.hosts
details about module ourobori.apps.dependencies.services
details about module ourobori.apps.http
details about module ourobori.apps.middlewares
details about module ourobori.apps.options
details about module ourobori.docs.swagger
details about module ourobori.docs.swagger_errors
details about module ourobori.services.apis.decorators
details about module ourobori.services.errors
details about module ourobori.services.http
details about module ourobori.services.logger
details about module ourobori.services.rules
details about module ourobori.services.schemata
rules for this service-style
PEP8
type-annotations
usage of pydantic-models / schemata
google-documentation-style
pytest
testing defaults
using parametrized tests
using fixtures
testing aiohttp-api-endpoints
developing inside conda environments
Example for a valid meta.yaml used by cenv
creating conda-package
git-workflow
write a changelog
usage
The code-part
errors.py
rules.py
service.py
folder processing
The schemata-part
The documentation-part
The README.md
The LICENSE
The CHANGELOG
The doc-part
The test-part
The packaging- and environment-part
The meta.yaml
The setup.py
Adding not-python-file to the resulting package
optimizations
requirements
use systemd for service
changelog
version 0.4.1
version 0.4.0
version 0.3.2
version 0.3.1
version 0.3.0
version 0.2.0
version 0.1.0
modules
ourobori
ourobori package
Subpackages
Module contents
see also
About
Impressum and Privacy Statement
Impressum
Legal Disclosure
Contact
Disclaimer
Accountability for links
Copyright
Privacy Statement
General
Inventory data
Disclosure
ourobori
Docs
»
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
G
|
H
|
I
|
K
|
L
|
N
|
O
|
P
|
R
|
S
|
U
|
V
_
_extract_http_response() (in module ourobori.apps.dependencies.services)
A
add_flag() (in module ourobori.apps.options)
add_param() (in module ourobori.apps.options)
additional_output_definitions (ourobori.docs.swagger.APISpec attribute)
,
[1]
alive_api (ourobori.apps.dependencies.services.RestService attribute)
alive_params (ourobori.apps.dependencies.services.RestService attribute)
,
[1]
api_ping() (in module ourobori.services.http)
api_url (ourobori.docs.swagger.APISpec attribute)
apidoc_location (ourobori.services.rules.BaseRules attribute)
,
[1]
APISpec (class in ourobori.docs.swagger)
app (ourobori.apps.dependencies.dbs.PSQLDataBase attribute)
auth (ourobori.apps.dependencies.services.RestService attribute)
,
[1]
AuthenticatedUser (class in ourobori.services.rules)
auths (ourobori.services.rules.BaseRules attribute)
,
[1]
B
BASE_APISPECS (in module ourobori.services.http)
base_url (ourobori.apps.dependencies.services.RestService attribute)
BaseError
BaseRules (class in ourobori.services.rules)
build_arguments() (in module ourobori.apps.options)
C
call_api() (ourobori.apps.dependencies.services.RestService method)
check_credentials() (ourobori.services.rules.CustomBasicAuth method)
client_apidoc_location (ourobori.services.rules.BaseRules attribute)
,
[1]
client_keys (ourobori.apps.dependencies.hosts.Host attribute)
Contact (class in ourobori.docs.swagger)
contact (ourobori.services.rules.BaseRules attribute)
,
[1]
create_error_output_def() (in module ourobori.docs.swagger_errors)
create_swagger_definition() (in module ourobori.docs.swagger)
CustomBasicAuth (class in ourobori.services.rules)
D
data (ourobori.docs.swagger_errors.SErrorModel attribute)
(ourobori.services.errors.BaseError attribute)
(ourobori.services.errors.DatabaseNotAliveException attribute)
(ourobori.services.errors.DatabaseTransactionException attribute)
(ourobori.services.errors.HostCmdException attribute)
(ourobori.services.errors.HostConnectionException attribute)
(ourobori.services.errors.HostSCPFromException attribute)
(ourobori.services.errors.HostSCPToException attribute)
(ourobori.services.errors.InvalidInputException attribute)
(ourobori.services.errors.InvalidOutputException attribute)
(ourobori.services.errors.ServiceCallException attribute)
(ourobori.services.errors.ServiceNotAliveException attribute)
DatabaseNotAliveException
DatabaseTransactionException
default_logger() (in module ourobori.services.logger)
description (ourobori.docs.swagger.APISpec attribute)
(ourobori.docs.swagger.OutputDefinition attribute)
(ourobori.services.errors.BaseError attribute)
(ourobori.services.errors.DatabaseNotAliveException attribute)
(ourobori.services.errors.DatabaseTransactionException attribute)
(ourobori.services.errors.HostCmdException attribute)
(ourobori.services.errors.HostConnectionException attribute)
(ourobori.services.errors.HostSCPFromException attribute)
(ourobori.services.errors.HostSCPToException attribute)
(ourobori.services.errors.InvalidInputException attribute)
(ourobori.services.errors.InvalidOutputException attribute)
(ourobori.services.errors.ServiceCallException attribute)
(ourobori.services.errors.ServiceNotAliveException attribute)
(ourobori.services.rules.BaseRules attribute)
,
[1]
dsn (ourobori.apps.dependencies.dbs.PSQLDataBase attribute)
E
email (ourobori.docs.swagger.Contact attribute)
error_middleware() (in module ourobori.apps.middlewares)
G
get_def() (ourobori.docs.swagger.APISpec method)
H
handle_exceptions (ourobori.services.rules.BaseRules attribute)
,
[1]
Host (class in ourobori.apps.dependencies.hosts)
host (ourobori.apps.dependencies.hosts.Host attribute)
HostCmdException
HostConnectionException
hostname (ourobori.services.rules.BaseRules attribute)
,
[1]
HostSCPFromException
HostSCPToException
I
input_description (ourobori.docs.swagger.APISpec attribute)
input_schema (ourobori.docs.swagger.APISpec attribute)
input_transform() (in module ourobori.services.apis.decorators)
InvalidInputException
InvalidOutputException
is_alive() (ourobori.apps.dependencies.dbs.PSQLDataBase method)
(ourobori.apps.dependencies.hosts.Host method)
(ourobori.apps.dependencies.services.RestService method)
K
known_hosts (ourobori.apps.dependencies.hosts.Host attribute)
L
License (class in ourobori.docs.swagger)
license (ourobori.services.rules.BaseRules attribute)
,
[1]
logfile (ourobori.services.rules.BaseRules attribute)
,
[1]
login (ourobori.services.rules.AuthenticatedUser attribute)
logstash_conn (ourobori.services.rules.BaseRules attribute)
,
[1]
N
name (ourobori.apps.dependencies.dbs.PSQLDataBase attribute)
(ourobori.apps.dependencies.hosts.Host attribute)
(ourobori.apps.dependencies.services.RestService attribute)
(ourobori.docs.swagger.Contact attribute)
(ourobori.docs.swagger.License attribute)
O
operation_id (ourobori.docs.swagger.APISpec attribute)
ourobori (module)
ourobori.apps (module)
ourobori.apps.dependencies (module)
ourobori.apps.dependencies.dbs (module)
ourobori.apps.dependencies.hosts (module)
ourobori.apps.dependencies.services (module)
ourobori.apps.http (module)
ourobori.apps.middlewares (module)
ourobori.apps.options (module)
ourobori.docs (module)
ourobori.docs.swagger (module)
ourobori.docs.swagger_errors (module)
ourobori.services (module)
ourobori.services.apis (module)
ourobori.services.apis.decorators (module)
ourobori.services.errors (module)
ourobori.services.http (module)
ourobori.services.logger (module)
ourobori.services.rules (module)
output_description (ourobori.docs.swagger.APISpec attribute)
output_schema (ourobori.docs.swagger.APISpec attribute)
output_transform() (in module ourobori.services.apis.decorators)
OutputDefinition (class in ourobori.docs.swagger)
P
password (ourobori.services.rules.AuthenticatedUser attribute)
(ourobori.services.rules.CustomBasicAuth attribute)
pool_name (ourobori.apps.dependencies.dbs.PSQLDataBase attribute)
port (ourobori.services.rules.BaseRules attribute)
,
[1]
prepare() (ourobori.apps.dependencies.dbs.PSQLDataBase method)
PSQLDataBase (class in ourobori.apps.dependencies.dbs)
pwd (ourobori.apps.dependencies.hosts.Host attribute)
R
RestService (class in ourobori.apps.dependencies.services)
ROUTES (in module ourobori.services.http)
run_cmd() (ourobori.apps.dependencies.hosts.Host method)
run_service() (in module ourobori.apps.http)
run_sql() (ourobori.apps.dependencies.dbs.PSQLDataBase method)
S
schema (ourobori.docs.swagger.OutputDefinition attribute)
scp_from() (ourobori.apps.dependencies.hosts.Host method)
scp_to() (ourobori.apps.dependencies.hosts.Host method)
SErrorModel (class in ourobori.docs.swagger_errors)
ServiceCallException
servicename (ourobori.services.rules.BaseRules attribute)
,
[1]
ServiceNotAliveException
set_connection_args() (ourobori.apps.dependencies.hosts.Host method)
set_pool_name() (ourobori.apps.dependencies.dbs.PSQLDataBase method)
status (ourobori.docs.swagger_errors.SErrorModel attribute)
(ourobori.services.errors.BaseError attribute)
(ourobori.services.errors.DatabaseNotAliveException attribute)
(ourobori.services.errors.DatabaseTransactionException attribute)
(ourobori.services.errors.HostCmdException attribute)
(ourobori.services.errors.HostConnectionException attribute)
(ourobori.services.errors.HostSCPFromException attribute)
(ourobori.services.errors.HostSCPToException attribute)
(ourobori.services.errors.InvalidInputException attribute)
(ourobori.services.errors.InvalidOutputException attribute)
(ourobori.services.errors.ServiceCallException attribute)
(ourobori.services.errors.ServiceNotAliveException attribute)
status_code (ourobori.docs.swagger.OutputDefinition attribute)
U
url (ourobori.docs.swagger.Contact attribute)
(ourobori.docs.swagger.License attribute)
user (ourobori.apps.dependencies.hosts.Host attribute)
username (ourobori.services.rules.CustomBasicAuth attribute)
V
version (ourobori.services.rules.BaseRules attribute)
,
[1]