dashborg-python-sdk 0.3.0.dev1

Dashborg Python SDK

Dashborg Python SDK

Modern internal tools. Defined, controlled, and deployed directly from backend code. No JavaScript. Secure.

• Define your UI in HTML
• Define handlers in Go/Python
• Run your program to deploy your app

Dashborg was built to be the simplest way to create secure web-based internal tools from backend code. Define your UI and control it completely within your backend code. All backend communication is secured with public/private key encryption. Add client password or user-account authentication with one line of code.

Documentation

• Doc Site: https://docs.dashborg.net/
• Tutorials: https://docs.dashborg.net/tutorials/t1/
• SDK Reference: https://docs.dashborg.net/reference/python-reference/
• PyPI: https://pypi.org/project/dashborg-python-sdk/
• Playground: https://console.dashborg.net/acc/421d595f-9e30-4178-bcc3-b853f890fb8e/default/playground
• Slack: Join the Dashborg Slack Channel

Key Features

• No Javascript - No context switching. Write your dashboards using pure HTML and backend code. No JavaScript environment to set up, no messing with NPM, Yarn, Webpack, Babel, React, Angular, etc.
• No Open Ports - No webhooks, firewall configuration, IP whitelists, or open ports required for your backend.
• No Frontend Hosting - You get a secure, internet accessible frontend out of the box. No web server configuration, domain name, load balancer, or WAF setup and configuration required.
• No Shared Passwords - No incoming connections to your infrastructure. Dashborg does not require or store your database passwords or API keys. It does not access any 3rd party service on your behalf.
• Built For Real Developers - Use the editor, libraries, and frameworks that you already use to write your tools -- no 3rd-party GUI tools to learn, or typing code into text boxes on a website. Easy to get started, but powerful enough to build complex tools and interactions.
• Secure - All connections are secured using SSL public/private key encryption with client auth. HTTPS on the frontend. Secure your dashboards with a simple password or user accounts. SSO coming soon.
• Control - Dashborg panels are 100% defined from your backend code. That means you can version them in your own code repository, and run and test them in your current dev, staging, and production environments.
• Modern Frontend Controls - Tables, Lists, Forms, Inputs, and Buttons all out of the box, with more to come! No Javascript or CSS frameworks required. All styled to look good and work together.

Dashborg Hello World

First install the Dashborg SDK:

pip install dashborg-python-sdk

The code below is the complete code for your first Dashborg program. Copy and paste it into a new file (demo.py).

import asyncio
import dashborg

async def root_handler(req):
    req.set_html("""
        <panel>
            <h1>Hello World</h1>
            <d-button handler="/run-handler">Run</d-button>
        </panel>
    """)

async def run_handler(req):
    print("Running Handler!")

async def main():
    config = dashborg.Config(proc_name="demo", anon_acc=True, auto_keygen=True)
    await dashborg.start_proc_client(config)
    await dashborg.register_panel_handler("default", "/", root_handler)
    await dashborg.register_panel_handler("default", "/run-handler", run_handler)
    while True:
        await asyncio.sleep(1)

asyncio.run(main())

You should see output that looks similar to:

Dashborg created new self-signed keypair key:dashborg-client.key cert:dashborg-client.crt for new accountid:[YOUR-ACCOUNT-ID]
Dashborg KeyFile:dashborg-client.key CertFile:dashborg-client.crt SHA256:[YOUR-KEY-FINGERPRINT]
Dashborg Initialized Client AccId:[YOUR-ACCOUNT-ID] Zone:default ProcName:demo ProcRunId:4f4e8364-5d39-495f-8c9e-1009741b1b47
Dashborg Panel Link [default]: https://console.dashborg.net/acc/YOUR-OWN-PRIVATE-LINK

Copy and paste your panel link (console.dashborg.net) into your browser to see your live dashboard!

Questions? Join the Dashborg Slack Channel