Metadata-Version: 2.1
Name: ellar-cli
Version: 0.2.7
Summary: Ellar CLI Tool for Scaffolding Ellar Projects, Modules and also running Ellar Commands
Author-email: Ezeudoh Tochukwu <tochukwu.ezeudoh@gmail.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: AsyncIO
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Dist: tomlkit >=0.11.1,<1.0.0,!=0.11.2,!=0.11.3
Requires-Dist: uvicorn[standard] == 0.23.2
Requires-Dist: ellar >= 0.5.8
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest >=7.1.3,<8.0.0 ; extra == "test"
Requires-Dist: pytest-cov >=2.12.0,<5.0.0 ; extra == "test"
Requires-Dist: mypy == 1.7.1 ; extra == "test"
Requires-Dist: ruff ==0.1.7 ; extra == "test"
Requires-Dist: pytest-asyncio ; extra == "test"
Requires-Dist: autoflake ; extra == "test"
Project-URL: Documentation, https://github.com/eadwinCode/ellar-cli
Project-URL: Homepage, https://eadwincode.github.io/ellar-cli/
Project-URL: Source, https://github.com/eadwinCode/ellar-cli
Provides-Extra: dev
Provides-Extra: test

<p align="center">
  <a href="#" target="blank"><img src="https://python-ellar.github.io/ellar/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
</p>

<p align="center"> Ellar CLI Tool for Scaffolding Ellar Projects and Modules and also running Ellar Commands</p>

![Test](https://github.com/python-ellar/ellar-cli/actions/workflows/test_full.yml/badge.svg)
![Coverage](https://img.shields.io/codecov/c/github/python-ellar/ellar-cli)
[![PyPI version](https://badge.fury.io/py/ellar-cli.svg)](https://badge.fury.io/py/ellar-cli)
[![PyPI version](https://img.shields.io/pypi/v/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)
[![PyPI version](https://img.shields.io/pypi/pyversions/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)

# Introduction
Ellar-CLI is an abstracted tool for the Ellar web framework that helps in the standard project scaffolding and managing typer and click commands.

Ellar CLI is build on [Typer](https://typer.tiangolo.com/) and works well with `click` command. 

## Installation
if you have [ellar](https://github.com/python-ellar/ellar) install ready
```
pip install ellar-cli
```

## Usage
To verify ellar-cli is working, run the command belove
```shell
ellar --help
```
Above command should output this:
```
Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...

Options:
  -p, --project TEXT              Run Specific Command on a specific project
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  create-module   - Scaffolds Ellar Application Module -
  create-project  - Scaffolds Ellar Application -
  new             - Runs a complete Ellar project scaffold and creates...
  runserver       - Starts Uvicorn Server -
  say-hi

```

Full Documentation: [Here](https://python-ellar.github.io/ellar/cli/introduction/)

