SecuServe Web Interface
Human-centered web interface infrastructure for SecuServe, designed to provide understandable, modular, and extensible interfaces for interacting with SecuServe systems, services, data, and security tools while keeping people and responsible system operation at the center.
Project
The smallest useful picture of what this project is.
SecuServe Web Interface
Human-centered web interface infrastructure for SecuServe, designed to provide understandable, modular, and extensible interfaces for interacting with SecuServe systems, services, data, and security tools while keeping people and responsible system operation at the center.
Principles
The rules and design principles the project is built around.
Components
The major systems and pieces that make up the project.
API Endpoints
Every discovered route is compact by default and expandable when you need its technical details.
Secuserve-WebInterface-module/app/base/routes.py
11 endpoints
GET
/
route_default
— No description documented yet.
/
No description documented yet.
GETPOST
/login
login
— No description documented yet.
/login
No description documented yet.
GETPOST
/register
register
— No description documented yet.
/register
No description documented yet.
GET
/logout
logout
— No description documented yet.
/logout
No description documented yet.
GETPOST
/dashboard
display
— No description documented yet.
/dashboard
No description documented yet.
GETPOST
/settings
settings
— No description documented yet.
/settings
No description documented yet.
GETPOST
/capturedfaces
capturedfaces
— No description documented yet.
/capturedfaces
No description documented yet.
POSTGET
/admin
sendAdminImage
— No description documented yet.
/admin
No description documented yet.
POSTGET
/user
sendUserImage
— No description documented yet.
/user
No description documented yet.
POSTGET
/unwanted
sendUnwantedImage
— No description documented yet.
/unwanted
No description documented yet.
POSTGET
/unknown
sendUnknownImage
— No description documented yet.
/unknown
No description documented yet.
Secuserve-WebInterface-module/app/home/routes.py
2 endpoints
GET
/index
index
— No description documented yet.
/index
No description documented yet.
GET
/<template>
route_template
— No description documented yet.
/<template>
No description documented yet.
template
SecuServeWebApp/app/base/routes.py
10 endpoints
GET
/
route_default
— No description documented yet.
/
No description documented yet.
GETPOST
/login
login
— No description documented yet.
/login
No description documented yet.
GETPOST
/register
register
— No description documented yet.
/register
No description documented yet.
GET
/logout
logout
— No description documented yet.
/logout
No description documented yet.
GETPOST
/dashboard
display
— No description documented yet.
/dashboard
No description documented yet.
GETPOST
/settings
settings
— No description documented yet.
/settings
No description documented yet.
POST
/admin
sendAdminImage
— No description documented yet.
/admin
No description documented yet.
POST
/user
sendUserImage
— No description documented yet.
/user
No description documented yet.
POST
/unwanted
sendUnwantedImage
— No description documented yet.
/unwanted
No description documented yet.
POST
/unknown
sendUnknownImage
— No description documented yet.
/unknown
No description documented yet.
SecuServeWebApp/app/home/routes.py
2 endpoints
GET
/index
index
— No description documented yet.
/index
No description documented yet.
GET
/<template>
route_template
— No description documented yet.
/<template>
No description documented yet.
template
Functions & Methods
Searchable, grouped symbols with details hidden until requested.
barkly_docs.py
50 symbols
esc
No description documented yet.
barkly_docs.py:236
No description documented yet.
esc(value: object) -> str
value
object
compact_doc
No description documented yet.
barkly_docs.py:240
No description documented yet.
compact_doc(doc: str, limit: int = 180) -> str
doc
str
limit
int
= 180
full_doc
No description documented yet.
barkly_docs.py:252
No description documented yet.
full_doc(doc: str) -> str
doc
str
expression_text
No description documented yet.
barkly_docs.py:259
No description documented yet.
expression_text(node: Optional[ast.AST]) -> str
node
Optional[ast.AST]
annotation_text
No description documented yet.
barkly_docs.py:269
No description documented yet.
annotation_text(node: Optional[ast.AST]) -> str
node
Optional[ast.AST]
relative_file
No description documented yet.
barkly_docs.py:273
No description documented yet.
relative_file(path: Path, root: Path) -> str
path
Path
root
Path
code_line
No description documented yet.
barkly_docs.py:280
No description documented yet.
code_line(file: str, line: int) -> str
file
str
line
int
short_hash
No description documented yet.
barkly_docs.py:284
No description documented yet.
short_hash(value: str) -> str
value
str
safe_call
No description documented yet.
barkly_docs.py:288
No description documented yet.
safe_call(command: list[str], cwd: Path) -> str
command
list[str]
cwd
Path
git_branch
No description documented yet.
barkly_docs.py:307
No description documented yet.
git_branch(root: Path) -> str
root
Path
git_commit
No description documented yet.
barkly_docs.py:314
No description documented yet.
git_commit(root: Path) -> str
root
Path
git_log
No description documented yet.
barkly_docs.py:321
No description documented yet.
git_log(root: Path, limit: int = 8) -> list[str]
root
Path
limit
int
= 8
node_doc
No description documented yet.
barkly_docs.py:343
No description documented yet.
node_doc(node: ast.AST) -> str
node
ast.AST
decorator_name
No description documented yet.
barkly_docs.py:347
No description documented yet.
decorator_name(node: ast.AST) -> str
node
ast.AST
decorator_text
No description documented yet.
barkly_docs.py:361
No description documented yet.
decorator_text(node: ast.AST) -> str
node
ast.AST
decorators_for
No description documented yet.
barkly_docs.py:365
No description documented yet.
decorators_for(node: ast.AST) -> list[str]
node
ast.AST
parameter_kind
No description documented yet.
barkly_docs.py:372
No description documented yet.
parameter_kind(name: str, default_node: Optional[ast.AST]) -> str
name
str
default_node
Optional[ast.AST]
collect_parameters
No description documented yet.
barkly_docs.py:397
No description documented yet.
collect_parameters(node: ast.FunctionDef | ast.AsyncFunctionDef) -> list[Parameter]
node
ast.FunctionDef | ast.AsyncFunctionDef
call_root_name
No description documented yet.
barkly_docs.py:465
No description documented yet.
call_root_name(node: ast.Call) -> str
node
ast.Call
extract_string_argument
No description documented yet.
barkly_docs.py:475
No description documented yet.
extract_string_argument(call: ast.Call, index: int = 0) -> str
call
ast.Call
index
int
= 0
extract_methods_keyword
No description documented yet.
barkly_docs.py:490
No description documented yet.
extract_methods_keyword(call: ast.Call) -> list[str]
call
ast.Call
endpoint_from_decorator
No description documented yet.
barkly_docs.py:509
No description documented yet.
endpoint_from_decorator(decorator: ast.AST, function: ast.FunctionDef | ast.AsyncFunctionDef, file: str) -> Optional[EndpointInfo]
decorator
ast.AST
function
ast.FunctionDef | ast.AsyncFunctionDef
file
str
scan_python
No description documented yet.
barkly_docs.py:770
No description documented yet.
scan_python(root: Path) -> PythonScanner
root
Path
symbol_key
No description documented yet.
barkly_docs.py:780
No description documented yet.
symbol_key(function: FunctionInfo) -> str
function
FunctionInfo
class_key
No description documented yet.
barkly_docs.py:784
No description documented yet.
class_key(item: ClassInfo) -> str
item
ClassInfo
endpoint_key
No description documented yet.
barkly_docs.py:788
No description documented yet.
endpoint_key(item: EndpointInfo) -> str
item
EndpointInfo
function_fingerprint
No description documented yet.
barkly_docs.py:797
No description documented yet.
function_fingerprint(item: FunctionInfo) -> str
item
FunctionInfo
class_fingerprint
No description documented yet.
barkly_docs.py:811
No description documented yet.
class_fingerprint(item: ClassInfo) -> str
item
ClassInfo
endpoint_fingerprint
No description documented yet.
barkly_docs.py:828
No description documented yet.
endpoint_fingerprint(item: EndpointInfo) -> str
item
EndpointInfo
load_state
No description documented yet.
barkly_docs.py:853
No description documented yet.
load_state(path: Path) -> dict
path
Path
apply_state
No description documented yet.
barkly_docs.py:879
No description documented yet.
apply_state(scanner: PythonScanner, previous: dict) -> dict
scanner
PythonScanner
previous
dict
load_project_config
No description documented yet.
barkly_docs.py:937
No description documented yet.
load_project_config(root: Path) -> dict
root
Path
init_project
No description documented yet.
barkly_docs.py:959
No description documented yet.
init_project(root: Path) -> None
root
Path
badge
No description documented yet.
barkly_docs.py:981
No description documented yet.
badge(text: str, kind: str = '') -> str
text
str
kind
str
= ''
status_badges
No description documented yet.
barkly_docs.py:995
No description documented yet.
status_badges(is_new: bool, is_changed: bool) -> str
is_new
bool
is_changed
bool
parameter_summary
No description documented yet.
barkly_docs.py:1015
No description documented yet.
parameter_summary(params: list[Parameter]) -> str
params
list[Parameter]
parameter_details
No description documented yet.
barkly_docs.py:1028
No description documented yet.
parameter_details(params: list[Parameter]) -> str
params
list[Parameter]
function_row
No description documented yet.
barkly_docs.py:1088
No description documented yet.
function_row(item: FunctionInfo, show_class: bool = False) -> str
item
FunctionInfo
show_class
bool
= False
method_group
No description documented yet.
barkly_docs.py:1197
No description documented yet.
method_group(title: str, functions: list[FunctionInfo]) -> str
title
str
functions
list[FunctionInfo]
class_group
No description documented yet.
barkly_docs.py:1262
No description documented yet.
class_group(item: ClassInfo) -> str
item
ClassInfo
endpoint_row
No description documented yet.
barkly_docs.py:1350
No description documented yet.
endpoint_row(item: EndpointInfo) -> str
item
EndpointInfo
module_row
No description documented yet.
barkly_docs.py:1465
No description documented yet.
module_row(module: ModuleInfo) -> str
module
ModuleInfo
section
No description documented yet.
barkly_docs.py:1544
No description documented yet.
section(number: str, title: str, description: str, body: str) -> str
number
str
title
str
description
str
body
str
info_card
No description documented yet.
barkly_docs.py:1584
No description documented yet.
info_card(title: str, value: str, description: str = '') -> str
title
str
value
str
description
str
= ''
simple_card_grid
No description documented yet.
barkly_docs.py:1611
No description documented yet.
simple_card_grid(values: list[str]) -> str
values
list[str]
search_toolbar
No description documented yet.
barkly_docs.py:1628
No description documented yet.
search_toolbar(input_id: str, count_id: str, new_id: str, placeholder: str) -> str
input_id
str
count_id
str
new_id
str
placeholder
str
build_html
No description documented yet.
barkly_docs.py:1674
No description documented yet.
build_html(project: dict, scanner: PythonScanner, state: dict, root: Path) -> str
project
dict
scanner
PythonScanner
state
dict
root
Path
generate
No description documented yet.
barkly_docs.py:3409
No description documented yet.
generate(source: Path, output: Path, name: Optional[str] = None, project_type: Optional[str] = None, status: Optional[str] = None) -> None
source
Path
output
Path
name
Optional[str]
= None
project_type
Optional[str]
= None
status
Optional[str]
= None
build_parser
No description documented yet.
barkly_docs.py:3501
No description documented yet.
build_parser() -> argparse.ArgumentParser
main
No description documented yet.
barkly_docs.py:3565
No description documented yet.
main() -> None
Secuserve-WebInterface-module/app/__init__.py
4 symbols
register_extensions
No description documented yet.
Secuserve-WebInterface-module/app/__init__.py:19
No description documented yet.
register_extensions(app)
app
register_blueprints
No description documented yet.
Secuserve-WebInterface-module/app/__init__.py:23
No description documented yet.
register_blueprints(app)
app
configure_database
No description documented yet.
Secuserve-WebInterface-module/app/__init__.py:28
No description documented yet.
configure_database(app)
app
create_app
No description documented yet.
Secuserve-WebInterface-module/app/__init__.py:41
No description documented yet.
create_app(config)
config
Secuserve-WebInterface-module/app/base/data_updater.py
1 symbols
update_load
No description documented yet.
Secuserve-WebInterface-module/app/base/data_updater.py:8
No description documented yet.
update_load()
Secuserve-WebInterface-module/app/base/models.py
2 symbols
user_loader
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:110
No description documented yet.
user_loader(id)
id
request_loader
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:114
No description documented yet.
request_loader(request)
request
Secuserve-WebInterface-module/app/base/routes.py
16 symbols
route_default
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:47
No description documented yet.
route_default()
login
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:53
No description documented yet.
login()
register
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:82
No description documented yet.
register()
logout
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:123
No description documented yet.
logout()
unauthorized_handler
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:130
No description documented yet.
unauthorized_handler()
access_forbidden
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:134
No description documented yet.
access_forbidden(error)
error
not_found_error
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:138
No description documented yet.
not_found_error(error)
error
internal_error
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:142
No description documented yet.
internal_error(error)
error
display
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:151
No description documented yet.
display()
settings
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:190
No description documented yet.
settings()
getFaceList
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:263
No description documented yet.
getFaceList(i)
i
capturedfaces
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:275
No description documented yet.
capturedfaces()
sendAdminImage
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:286
No description documented yet.
sendAdminImage()
sendUserImage
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:304
No description documented yet.
sendUserImage()
sendUnwantedImage
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:320
No description documented yet.
sendUnwantedImage()
sendUnknownImage
No description documented yet.
Secuserve-WebInterface-module/app/base/routes.py:334
No description documented yet.
sendUnknownImage()
Secuserve-WebInterface-module/app/base/util.py
2 symbols
hash_pass
Hash a password for storing.
Secuserve-WebInterface-module/app/base/util.py:10
Hash a password for storing.
hash_pass(password)
password
verify_pass
Verify a stored password against one provided by user
Secuserve-WebInterface-module/app/base/util.py:18
Verify a stored password against one provided by user
verify_pass(provided_password, stored_password)
provided_password
stored_password
Secuserve-WebInterface-module/app/home/routes.py
3 symbols
index
No description documented yet.
Secuserve-WebInterface-module/app/home/routes.py:14
No description documented yet.
index()
route_template
No description documented yet.
Secuserve-WebInterface-module/app/home/routes.py:20
No description documented yet.
route_template(template)
template
get_segment
No description documented yet.
Secuserve-WebInterface-module/app/home/routes.py:40
No description documented yet.
get_segment(request)
request
SecuServeWebApp/app/__init__.py
4 symbols
register_extensions
No description documented yet.
SecuServeWebApp/app/__init__.py:19
No description documented yet.
register_extensions(app)
app
register_blueprints
No description documented yet.
SecuServeWebApp/app/__init__.py:23
No description documented yet.
register_blueprints(app)
app
configure_database
No description documented yet.
SecuServeWebApp/app/__init__.py:28
No description documented yet.
configure_database(app)
app
create_app
No description documented yet.
SecuServeWebApp/app/__init__.py:41
No description documented yet.
create_app(config)
config
SecuServeWebApp/app/base/data_updater.py
1 symbols
update_load
No description documented yet.
SecuServeWebApp/app/base/data_updater.py:8
No description documented yet.
update_load()
SecuServeWebApp/app/base/models.py
2 symbols
user_loader
No description documented yet.
SecuServeWebApp/app/base/models.py:94
No description documented yet.
user_loader(id)
id
request_loader
No description documented yet.
SecuServeWebApp/app/base/models.py:98
No description documented yet.
request_loader(request)
request
SecuServeWebApp/app/base/routes.py
15 symbols
route_default
No description documented yet.
SecuServeWebApp/app/base/routes.py:40
No description documented yet.
route_default()
login
No description documented yet.
SecuServeWebApp/app/base/routes.py:46
No description documented yet.
login()
register
No description documented yet.
SecuServeWebApp/app/base/routes.py:75
No description documented yet.
register()
logout
No description documented yet.
SecuServeWebApp/app/base/routes.py:115
No description documented yet.
logout()
unauthorized_handler
No description documented yet.
SecuServeWebApp/app/base/routes.py:122
No description documented yet.
unauthorized_handler()
access_forbidden
No description documented yet.
SecuServeWebApp/app/base/routes.py:126
No description documented yet.
access_forbidden(error)
error
not_found_error
No description documented yet.
SecuServeWebApp/app/base/routes.py:130
No description documented yet.
not_found_error(error)
error
internal_error
No description documented yet.
SecuServeWebApp/app/base/routes.py:134
No description documented yet.
internal_error(error)
error
display
No description documented yet.
SecuServeWebApp/app/base/routes.py:143
No description documented yet.
display()
settings
No description documented yet.
SecuServeWebApp/app/base/routes.py:179
No description documented yet.
settings()
getFaceList
No description documented yet.
SecuServeWebApp/app/base/routes.py:264
No description documented yet.
getFaceList(i)
i
sendAdminImage
No description documented yet.
SecuServeWebApp/app/base/routes.py:277
No description documented yet.
sendAdminImage()
sendUserImage
No description documented yet.
SecuServeWebApp/app/base/routes.py:285
No description documented yet.
sendUserImage()
sendUnwantedImage
No description documented yet.
SecuServeWebApp/app/base/routes.py:292
No description documented yet.
sendUnwantedImage()
sendUnknownImage
No description documented yet.
SecuServeWebApp/app/base/routes.py:298
No description documented yet.
sendUnknownImage()
SecuServeWebApp/app/base/util.py
2 symbols
hash_pass
Hash a password for storing.
SecuServeWebApp/app/base/util.py:10
Hash a password for storing.
hash_pass(password)
password
verify_pass
Verify a stored password against one provided by user
SecuServeWebApp/app/base/util.py:18
Verify a stored password against one provided by user
verify_pass(provided_password, stored_password)
provided_password
stored_password
SecuServeWebApp/app/home/routes.py
3 symbols
index
No description documented yet.
SecuServeWebApp/app/home/routes.py:14
No description documented yet.
index()
route_template
No description documented yet.
SecuServeWebApp/app/home/routes.py:20
No description documented yet.
route_template(template)
template
get_segment
No description documented yet.
SecuServeWebApp/app/home/routes.py:40
No description documented yet.
get_segment(request)
request
barkly_docs.py · FunctionInfo
2 symbols
qualified_name
No description documented yet.
barkly_docs.py:164
No description documented yet.
qualified_name(self) -> str
self
signature
No description documented yet.
barkly_docs.py:170
No description documented yet.
signature(self) -> str
self
barkly_docs.py · EndpointInfo
1 symbols
method_text
No description documented yet.
barkly_docs.py:220
No description documented yet.
method_text(self) -> str
self
barkly_docs.py · PythonScanner
7 symbols
__init__
No description documented yet.
barkly_docs.py:610
No description documented yet.
__init__(self, root: Path)
self
root
Path
scan
No description documented yet.
barkly_docs.py:618
No description documented yet.
scan(self) -> None
self
scan_file
No description documented yet.
barkly_docs.py:625
No description documented yet.
scan_file(self, path: Path) -> None
self
path
Path
function_node_for_class_method
No description documented yet.
barkly_docs.py:683
No description documented yet.
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]
self
class_node
ast.ClassDef
method_name
str
make_function
No description documented yet.
barkly_docs.py:698
No description documented yet.
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfo
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
make_class
No description documented yet.
barkly_docs.py:717
No description documented yet.
make_class(self, node: ast.ClassDef, file: str) -> ClassInfo
self
node
ast.ClassDef
file
str
find_endpoints
No description documented yet.
barkly_docs.py:747
No description documented yet.
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> None
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
Secuserve-WebInterface-module/app/base/datestruct.py · DateData
16 symbols
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:19
No description documented yet.
__init__(self, monday: int, tuseday: int, wensday: int, thursday: int, friday: int, saterday: int, sunday: int) -> int
self
monday
int
tuseday
int
wensday
int
thursday
int
friday
int
saterday
int
sunday
int
setMonday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:31
No description documented yet.
setMonday(self, monday) -> int
self
monday
setTuesday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:43
No description documented yet.
setTuesday(self, tuesday) -> int
self
tuesday
setWensday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:56
No description documented yet.
setWensday(self, wensday) -> int
self
wensday
setThrusday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:71
No description documented yet.
setThrusday(self, thrusday) -> int
self
thrusday
setFriday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:85
No description documented yet.
setFriday(self, friday) -> int
self
friday
setSaterday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:99
No description documented yet.
setSaterday(self, saterday) -> int
self
saterday
setSunday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:112
No description documented yet.
setSunday(self, sunday) -> int
self
sunday
getModay
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:124
No description documented yet.
getModay(self) -> int
self
getTuesay
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:127
No description documented yet.
getTuesay(self) -> int
self
getWensday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:130
No description documented yet.
getWensday(self) -> int
self
getThursday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:133
No description documented yet.
getThursday(self) -> int
self
getFriday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:136
No description documented yet.
getFriday(self) -> int
self
getSaterday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:139
No description documented yet.
getSaterday(self) -> int
self
getSunday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:142
No description documented yet.
getSunday(self) -> int
self
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:146
No description documented yet.
__repr__(self)
self
Secuserve-WebInterface-module/app/base/models.py · User
2 symbols
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:25
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:39
No description documented yet.
__repr__(self)
self
Secuserve-WebInterface-module/app/base/models.py · Face
2 symbols
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:57
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:71
No description documented yet.
__repr__(self)
self
SecuServeWebApp/app/base/models.py · User
2 symbols
__init__
No description documented yet.
SecuServeWebApp/app/base/models.py:22
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
SecuServeWebApp/app/base/models.py:36
No description documented yet.
__repr__(self)
self
SecuServeWebApp/app/base/models.py · Face
2 symbols
__init__
No description documented yet.
SecuServeWebApp/app/base/models.py:54
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
SecuServeWebApp/app/base/models.py:68
No description documented yet.
__repr__(self)
self
Classes
Classes stay collapsed so large projects remain readable.
Parameter
No description documented yet.
0 methods
FunctionInfo
No description documented yet.
2 methods
qualified_name
No description documented yet.
barkly_docs.py:164
No description documented yet.
qualified_name(self) -> str
self
signature
No description documented yet.
barkly_docs.py:170
No description documented yet.
signature(self) -> str
self
ClassInfo
No description documented yet.
0 methods
EndpointInfo
No description documented yet.
1 methods
method_text
No description documented yet.
barkly_docs.py:220
No description documented yet.
method_text(self) -> str
self
ModuleInfo
No description documented yet.
0 methods
PythonScanner
No description documented yet.
7 methods
__init__
No description documented yet.
barkly_docs.py:610
No description documented yet.
__init__(self, root: Path)
self
root
Path
scan
No description documented yet.
barkly_docs.py:618
No description documented yet.
scan(self) -> None
self
scan_file
No description documented yet.
barkly_docs.py:625
No description documented yet.
scan_file(self, path: Path) -> None
self
path
Path
function_node_for_class_method
No description documented yet.
barkly_docs.py:683
No description documented yet.
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]
self
class_node
ast.ClassDef
method_name
str
make_function
No description documented yet.
barkly_docs.py:698
No description documented yet.
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfo
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
make_class
No description documented yet.
barkly_docs.py:717
No description documented yet.
make_class(self, node: ast.ClassDef, file: str) -> ClassInfo
self
node
ast.ClassDef
file
str
find_endpoints
No description documented yet.
barkly_docs.py:747
No description documented yet.
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> None
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
DateData
No description documented yet.
16 methods
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:19
No description documented yet.
__init__(self, monday: int, tuseday: int, wensday: int, thursday: int, friday: int, saterday: int, sunday: int) -> int
self
monday
int
tuseday
int
wensday
int
thursday
int
friday
int
saterday
int
sunday
int
setMonday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:31
No description documented yet.
setMonday(self, monday) -> int
self
monday
setTuesday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:43
No description documented yet.
setTuesday(self, tuesday) -> int
self
tuesday
setWensday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:56
No description documented yet.
setWensday(self, wensday) -> int
self
wensday
setThrusday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:71
No description documented yet.
setThrusday(self, thrusday) -> int
self
thrusday
setFriday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:85
No description documented yet.
setFriday(self, friday) -> int
self
friday
setSaterday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:99
No description documented yet.
setSaterday(self, saterday) -> int
self
saterday
setSunday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:112
No description documented yet.
setSunday(self, sunday) -> int
self
sunday
getModay
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:124
No description documented yet.
getModay(self) -> int
self
getTuesay
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:127
No description documented yet.
getTuesay(self) -> int
self
getWensday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:130
No description documented yet.
getWensday(self) -> int
self
getThursday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:133
No description documented yet.
getThursday(self) -> int
self
getFriday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:136
No description documented yet.
getFriday(self) -> int
self
getSaterday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:139
No description documented yet.
getSaterday(self) -> int
self
getSunday
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:142
No description documented yet.
getSunday(self) -> int
self
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/datestruct.py:146
No description documented yet.
__repr__(self)
self
LoginForm
No description documented yet.
0 methods
CreateAccountForm
No description documented yet.
0 methods
AddFaceForm
No description documented yet.
0 methods
RemoveFaceForm
No description documented yet.
0 methods
User
No description documented yet.
2 methods
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:25
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:39
No description documented yet.
__repr__(self)
self
Face
No description documented yet.
2 methods
__init__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:57
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
Secuserve-WebInterface-module/app/base/models.py:71
No description documented yet.
__repr__(self)
self
SeenFaces
No description documented yet.
0 methods
ZigbeeDevices
No description documented yet.
0 methods
Config
No description documented yet.
0 methods
ProductionConfig
No description documented yet.
0 methods
DebugConfig
No description documented yet.
0 methods
LoginForm
No description documented yet.
0 methods
CreateAccountForm
No description documented yet.
0 methods
AddFaceForm
No description documented yet.
0 methods
RemoveFaceForm
No description documented yet.
0 methods
User
No description documented yet.
2 methods
__init__
No description documented yet.
SecuServeWebApp/app/base/models.py:22
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
SecuServeWebApp/app/base/models.py:36
No description documented yet.
__repr__(self)
self
Face
No description documented yet.
2 methods
__init__
No description documented yet.
SecuServeWebApp/app/base/models.py:54
No description documented yet.
__init__(self, **kwargs)
self
**kwargs
__repr__
No description documented yet.
SecuServeWebApp/app/base/models.py:68
No description documented yet.
__repr__(self)
self
SeenFaces
No description documented yet.
0 methods
Config
No description documented yet.
0 methods
ProductionConfig
No description documented yet.
0 methods
DebugConfig
No description documented yet.
0 methods
Modules
A lightweight map of source files and their discovered contents.
barkly_docs.py
66 symbols
10 imports
Secuserve-WebInterface-module/app/__init__.py
4 symbols
9 imports
Secuserve-WebInterface-module/app/base/__init__.py
0 symbols
1 imports
Secuserve-WebInterface-module/app/base/const.py
0 symbols
0 imports
Secuserve-WebInterface-module/app/base/data_updater.py
1 symbols
2 imports
Secuserve-WebInterface-module/app/base/datestruct.py
17 symbols
1 imports
Secuserve-WebInterface-module/app/base/forms.py
4 symbols
5 imports
Secuserve-WebInterface-module/app/base/models.py
10 symbols
7 imports
Secuserve-WebInterface-module/app/base/routes.py
16 symbols
24 imports
Secuserve-WebInterface-module/app/base/util.py
2 symbols
3 imports
Secuserve-WebInterface-module/app/const.py
0 symbols
0 imports
Secuserve-WebInterface-module/app/home/__init__.py
0 symbols
1 imports
Secuserve-WebInterface-module/app/home/routes.py
3 symbols
5 imports
Secuserve-WebInterface-module/config.py
3 symbols
3 imports
Secuserve-WebInterface-module/gunicorn-cfg.py
0 symbols
0 imports
Secuserve-WebInterface-module/run.py
0 symbols
10 imports
SecuServeWebApp/__main__.py
0 symbols
10 imports
SecuServeWebApp/app/__init__.py
4 symbols
9 imports
SecuServeWebApp/app/base/__init__.py
0 symbols
1 imports
SecuServeWebApp/app/base/const.py
0 symbols
0 imports
SecuServeWebApp/app/base/data_updater.py
1 symbols
2 imports
SecuServeWebApp/app/base/forms.py
4 symbols
5 imports
SecuServeWebApp/app/base/models.py
9 symbols
4 imports
SecuServeWebApp/app/base/routes.py
15 symbols
20 imports
SecuServeWebApp/app/base/util.py
2 symbols
3 imports
SecuServeWebApp/app/const.py
0 symbols
0 imports
SecuServeWebApp/app/home/__init__.py
0 symbols
1 imports
SecuServeWebApp/app/home/routes.py
3 symbols
5 imports
SecuServeWebApp/config.py
3 symbols
2 imports
SecuServeWebApp/gunicorn-cfg.py
0 symbols
0 imports
Imports
Dependencies discovered from Python import statements.
Lifecycle
The development path used by the project.
Git
Repository state and recent development history.
dffc43f|2026-09-27|working on getting stuff to work with te barkly code analzaier
e78c5c5|2026-09-27|Merge pull request #1 from Barkly-Labs/dev
34d0b81|2022-03-19|working on setting up security system web page to display current images
8e95ad2|2022-03-19|got stuff working now i need to make sure it will reach out to a public ip
176ad37|2022-03-19|adding captured faces display
ddc3cf8|2022-03-13|added sensor database
71ca037|2022-02-24|working on getting layout fixed and then working on getting docker to run
2a779d5|2022-01-28|fixing uwu
Changelog
What BARKLY DOCS noticed changed between documentation generations.
BARKLY DOCS stores a small local snapshot of discovered symbols and compares the next scan against it. The scanner uses static Python AST analysis and never imports or executes the project.
On the first generation, the existing project becomes the baseline. Later generations can identify newly discovered and changed functions, methods, classes, and API endpoints.