Metadata-Version: 2.1
Name: mandatum
Version: 1.1.0
Summary: A python framework to make beatiful cli applications
Home-page: https://github.com/CalculusAI/mandatum
License: MIT
Author: Zayed Malick
Author-email: zayedmalick13@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: rich (>=7.0.0,<8.0.0)
Project-URL: Repository, https://github.com/CalculusAI/mandatum
Description-Content-Type: text/markdown

# Mandatum
Mandatum is a python framework based on rich-python to create beatiful Command-Line-Interface applications in no time. It can create interface for your application in an object oriented approach

## Installation
To install via pip type the following command
```bash
pip install mandatum
```

OR

Install poetry
```bash
pip install poetry
```

Clone this repo
```bash
git clone https://github.com/CalculusAI/mandatum
```

Change directory to mandatum and type
```bash
poetry install
```

## Getting Started
Lets create a basic application with mandatum

```python
import mandatum

# Initial setup
menu = mandatum.Menu(options=["Opt1", "Opt2"], bold_text=True)
prompt = mandatum.Prompt(color="blue")
alert = mandatum.Alert(bold_text=True)
warning = mandatum.Warning()

if __name__ == "__main__":

    # Displaying Menu
    menu.start()

    # User name
    name = prompt.input("\nEnter your name : ")
    print(name)

    # Alerts
    alert.alert("\nAlerting")

    # Warning
    warning.warn(message="\nWarning!", bold_text=True)
```

## License
mandatum is licensed under the terms of MIT license
