Metadata-Version: 2.1
Name: bloxs
Version: 1.0.0
Summary: Display data in an attractive way
Home-page: https://github.com/mljar/bloxs
Author: MLJAR, Sp. z o.o.
Author-email: contact@mljar.com
License: Apache License 2.0
Description: <p align="center">
        <img src="https://raw.githubusercontent.com/mljar/visual-identity/main/bloxs/blox%20line%20white.png" />
        </p>
        
        # Bloxs
        
        Bloxs is a simple python package that helps you display information in an attractive way (formed in blocks).
        
        It works with: Jupyter Notebook, Google Colab, Deepnote, Kaggle Notebook, [Mercury](https://github.com/mljar/mercury).
        
        ## Get started
        
        Install bloxs:
        
        ```
        pip install bloxs
        ```
        
        Import and create a bloxs
        ```
        from bloxs import B
        B(1234, "Bloxs in notebook!")
        ```
        
        ![](docs/media/test_bloxs.png)
        
        ## Exmaples
        
        | Bloxs | Code |
        | --- | --- |
        | ![](docs/media/number.png) | ```B(1234, "Bloxs in notebook!")``` |
        | ![](docs/media/percent.png) | `B(1999, "Percent change!", percent_change=10)` |
        | ![](docs/media/emojis.png) | `B("🎉🎉🎉", "Works with emojis")` |
        | ![](docs/media/progress.png) | `B("68%", "Loading progress", progress=68)` |
        | ![](docs/media/progress_color.png) | `B("68%", "Loading progress", progress=68, color="green")` color can be "blue", "red", "green" or custom in hex format (exmaple "#fa33fa") |
        | ![](docs/media/line_chart.png) | `B("123", "Display line chart", points=[1,4,2,3,5,6])` |
        | ![](docs/media/line_chart_color.png) | `B("123", "Display line chart", points=[1,4,2,3,5,6], color="red")` |
        | ![](docs/media/stepped.png) | `B("123", "Display stepped chart", points=[1,4,2,3,5,6], chart_type="stepped")` |
        | ![](docs/media/bar_chart.png) | `B("123", "Display bar chart", points=[1,4,2,3,5,6], chart_type="bar")` |
        | ![](docs/media/bar_chart_color.png) | `B("123", "Display bar chart", points=[1,4,2,3,5,6], chart_type="bar", color="green")` |
        
        
        You can combine several bloxs in one row:
        
        ```
        B([
            B(1999, "Percent change!", percent_change=10),
            B("🎉🎉🎉", "Works with emojis"),
            B("68%", "Loading progress", progress=68),
            B(1234, "Bloxs in notebook!")
        ])
        ```
        
        ![](docs/media/several_bloxs_2.png) 
        
        
        ```
        B([
            B("786", "Display bar chart", points=[1,4,2,3,5,6], chart_type="bar", color="green"),
            B("123", "Display line chart", points=[1,4,2,3,5,6], color="red"),
            B("123", "Display stepped chart", points=[1,4,2,3,5,6], chart_type="stepped")
        ])
        ```
        
        ![](docs/media/several_bloxs.png) 
        
        ## Bloxs work great with Mercury
        
        [Mercury](https://github.com/mljar/mercury) is a framework for converting notebook to interactive web app. It adds widgets to the notebook based on YAML config. Below is presented a notebook with bloxs and the same notebook served as web app with Mercury.
        
        #### The notebook with bloxs
        
        ![](docs/media/bloxs_notebook.gif)
        
        #### The Mercury web app
        
        ![](docs/media/bloxs_mercury.gif)
        
        The web app is available on [our server](https://mercury.mljar.com/app/5) :computer:
        
Keywords: data science,jupyter notebook,data analytics,dashboard,mljar
Platform: UNKNOWN
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
