StreetSign Developer Reference

This is the mainly autodoc generated documentation from the source code docstrings.

• API/Urls
  • /health
  • /robots.txt
  • /screens/
  • /screens-edit/<int:screenid>
  • /screens/<template>/<screenname>
  • /screens/json/<int:screen_id>
  • /screens/posts_from_feeds/<[list,of,feed,ids]>
  • /screens/post_types.js
  • /aliases
  • /client/<alias_name>
  • /screens/heartbeat/<int:screen_id>
  • /clients
  • /clients/json
  • /clients/refresh
  • /feeds/
  • /feeds-edit/<int:feedid>
  • /posts/
  • /post-edit/<int:postid>
  • /posts/<int:postid>/json
  • /posts/housekeeping
  • /posts/delete_orphaned_media
  • /post/<int:postid>/publish
  • /login
  • /logout
  • /users/
  • /users-edit/<int:userid>
  • /groups/
  • /groups-edit/<int:groupid>
  • /user_settings/
  • /file_browser/
  • /file_browser/<path:subdir>
  • /user_files/<path:filename>
  • /thumbnail/<path:filename>
• streetsign_server.models
  • Utility functions
    • safe_json_load()
    • eval_datetime_formula()
    • by_id()
  • Database initialisation
    • init()
    • create_all()
    • migrations()
  • Users and Groups
    • User
    • Group
    • UserGroup
  • Login Stuff
    • UserSession
    • user_login()
    • get_logged_in_user()
    • user_logout()
    • InvalidPassword
  • Posts and Feeds
    • Feed
    • FeedPermission
    • Post
    • ExternalSource
  • Screens and Output
    • Screen
  • Misc
    • ConfigVar
• streetsign_server.user_session
  • NotLoggedIn
  • get_user()
  • is_admin()
  • logged_in()
  • login()
  • logout()
• streetsign_server.views
  • streetsign_server.views
  • before_the_action()
  • health()
  • index()
  • inject_csrf()
  • not_logged_in()
  • robots_txt()
  • weather_proxy()
  • Utilities
    • streetsign_server.views.utils
    • PleaseRedirect
    • admin_only()
    • getbool()
    • getint()
    • getstr()
    • not_found()
    • permission_denied()
    • registered_users_only()
    • safe_referrer()
  • Users and Authentication
    • streetsign_server.views.users_and_auth
    • group()
    • login()
    • logout()
    • update_user()
    • user_edit()
    • users_and_groups()
  • The Screen Output Views
    • streetsign_server.views.screens
    • client_alias()
    • clients_json()
    • clients_page()
    • clients_refresh()
    • form_json()
    • post_types_js()
    • save_aliases()
    • screen_heartbeat()
    • screen_json()
    • screendisplay()
    • screenedit()
    • screens()
    • screens_posts_from_feeds()
  • Feeds and Posts
    • streetsign_server.views.feeds_and_posts
    • RSSFeed
    • bulk_upload()
    • external_data_source_edit()
    • external_data_sources_update_all()
    • external_source_run()
    • external_source_test()
    • feed_reorder()
    • feedpage()
    • feeds()
    • feedsrss()
    • json_post()
    • post_new()
    • postedit_type()
    • postpage()
    • posts()
    • posts_bulk_delete()
    • posts_housekeeping()
  • User uploaded files
    • streetsign_server.views.user_files
    • allow_filetype()
    • human_size_str()
    • locals_dict()
    • make_dirlist()
    • thumbnail()
    • user_files_list()
    • user_fonts()
    • user_fonts_css()
• streetsign_server.logic
  • Feeds and Posts
    • streetsign_server.logic.feeds_and_posts
    • can_user_write_and_publish()
    • clean_date()
    • cleanup_orphaned_media_files()
    • delete_post_and_run_callback()
    • if_i_cant_write_then_i_quit()
    • import_source_posts()
    • post_form_intake()
    • try_to_set_feed()
  • Connected Clients
    • streetsign_server.logic.clients
    • client_ip()
    • connected_clients()
    • record_heartbeat()
    • request_refresh()
    • reset()
  • URL Safety
    • streetsign_server.logic.urlsafety
    • UnsafeURL
    • check_fetch_url()
• streetsign_server.post_types
  • Post Type Generic Module Overview
    • Inside each module,
  • Rendering Screen Zones
    • streetsign_server.post_types
    • load()
    • module_dict()
    • modules()
    • my()
    • path_to_module()
    • renderers()
    • types()
    • streetsign_server.post_types.html
    • display()
    • form()
    • receive()
    • safecolor()
    • safehtml()
    • screen_js()
    • streetsign_server.post_types.text
    • display()
    • form()
    • receive()
    • screen_js()
    • streetsign_server.post_types.image
    • allow_filetype()
    • delete()
    • display()
    • form()
    • image_path()
    • receive()
    • resize_image()
    • run_local_script()
    • screen_js()
    • streetsign_server.post_types.video
    • allow_filetype()
    • delete()
    • display()
    • form()
    • receive()
    • screen_js()
    • video_path()
    • streetsign_server.post_types.external_webpage
    • display()
    • form()
    • receive()
    • screen_js()
    • streetsign_server.post_types.raw_html
    • display()
    • form()
    • receive()
    • screen_js()
    • display()
    • form()
    • receive()
    • screen_js()
• streetsign_server.external_source_types
  • The main external Source Types:
    • load()
    • module_dict()
    • modules()
    • my()
    • path_to_module()
    • types()
  • The RSS Source Type
    • form()
    • get_new()
    • make_templater()
    • receive()
    • test()
  • The Local Folder Source Type
    • form()
    • get_new()
    • receive()
    • test()