Metadata-Version: 2.1
Name: boardify
Version: 0.5.0
Summary: A web-based dashboard to analyzing your data with Python
Home-page: https://github.com/Lanseuo/boardify
Author: Lucas Hild
Author-email: contact@lucas-hild.de
License: MIT
Description: # boardify
        
        A web-based dashboard to analyzing your data with Python
        
        ![](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
        [![PyPI](https://img.shields.io/pypi/v/boardify.svg?style=flat-square&colorB=dfb317)](https://pypi.org/project/boardify/)
        [![Requirements Status](https://requires.io/github/Lanseuo/boardify/requirements.svg?branch=master)](https://requires.io/github/Lanseuo/boardify/requirements/?branch=master)
        
        ![Screenshot](https://raw.githubusercontent.com/Lanseuo/boardify/master/screenshot.png)
        
        ## Installation
        
        ```bash
        pip3 install boardify
        ```
        
        ## Usage
        
        ```python
        from boardify import BaseDashboard, BaseBlock, BarChart
        
        
        # Class for the dashboard
        class FruitDashboard(BaseDashboard):
            def config(self):
                self.name = "Fruit Company"
        
                # Add Blocks to the dashboard
                self.add_block(Products)
                self.add_block(NicestFruit)
        
        
        # Block contains HTML Code
        class Products(BaseBlock):
            def config(self):
                self.name = "Products"
                self.description = "A list of our products"
        
            def generate(self):
                return """<ul>
                <li>Apple</li>
                <li>Orange</li>
                <li>Banana</li>
                <li>Kiwifruit</li>
                <li>Blueberry</li>
                <li>Grapes</li>
                </ul>"""
        
        
        # Block renders a bar chart
        class NicestFruit(BarChart):
            def config(self):
                self.name = "Nicest Fruit"
                self.description = ("A survey of 145 people asked them "
                                    "\"Which is the nicest fruit?\"")
        
            def data(self):
                return {
                    "datasets": {
                        "Survey One": [35, 20, 45, 10, 30, 5],
                        "Survey Two": [30, 25, 60, 5, 35, 0],
                    },
                    "labels": ["Apple",
                               "Orange",
                               "Banana",
                               "Kiwifruit",
                               "Blueberry",
                               "Grapes"],
                    "background_color": ["rgb(128, 18, 2)",
                                         "rgb(244, 132, 0)",
                                         "rgb(246, 221, 0)",
                                         "rgba(83, 65, 25, 0.97)",
                                         "rgb(35, 123, 214)",
                                         "rgb(99, 74, 161)"]
                }
        
        
        # Run the server
        dashboard = FruitDashboard()
        dashboard.run()
        ```
        
        Open the dashboard at [http://localhost:7000](http://localhost:7000)
        
        ## Made with
        
        - [Flask](http://flask.pocoo.org) - web framework
        - [Chart.js](http://www.chartjs.org/) - charts made with JavaScript
        
        ## Meta
        
        Lucas Hild - [https://lucas-hild.de](https://lucas.hild.de)  
        This project is licensed under the MIT License - see the LICENSE file for details
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
