Metadata-Version: 2.1
Name: dashboard
Version: 0.0.6
Summary: An admin dashboard.
Home-page: https://github.com/encode/dashboard
Author: Tom Christie
Author-email: tom@tomchristie.com
License: BSD
Description: An admin dashboard for use with ASGI web frameworks.
        
        Work in progress.
        
        **example.py**
        
        ```python
        from starlette.applications import Starlette
        from starlette.routing import Mount, Route
        from starlette.responses import RedirectResponse
        from starlette.templating import Jinja2Templates
        from starlette.staticfiles import StaticFiles
        import databases
        import dashboard
        import orm
        import datetime
        
        
        database = databases.Database('sqlite:///test.db')
        models = orm.ModelRegistry(database=database)
        statics = StaticFiles(packages=['dashboard'])
        
        
        class Notes(orm.Model):
            registry = models
            tablename = 'notes'
            fields = {
                'id': orm.Integer(title="ID", primary_key=True, read_only=True),
                'created': orm.DateTime(title="Created", default=datetime.datetime.now, read_only=True),
                'text': orm.String(title="Text", max_length=100),
                'completed': orm.Boolean(title="Completed", default=False)
            }
        
        admin = dashboard.Dashboard(tables=[
            dashboard.DashboardTable(ident="notes", title="Notes", datasource=Notes.objects.order_by('-id')),
        ])
        
        
        routes = [
            Mount("/admin", app=admin, name='dashboard'),
            Mount("/statics", app=statics, name='static'),
            Route("/", endpoint=RedirectResponse(url='/admin')),
        ]
        
        app = Starlette(debug=True, routes=routes, on_startup=[database.connect], on_shutdown=[database.disconnect])
        ```
        
        Rough installation...
        
        ```shell
        $ virtualenv venv
        $ venv/bin/pip install dashboard
        $ venv/bin/python
        >>> from example import models
        >>> models.create_all()
        $ venv/bin/uvicorn example:app
        ```
        
        With many thanks to Eren Güven ([Twitter](https://twitter.com/cyberfart), [GitHub](https://github.com/eguven/)) for the `dashboard` PyPI package name.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
