python-ellar / ellar-cli

Ellar CLI Tooling

Ellar CLI Tool for Scaffolding Ellar Projects and Modules and also running Ellar Commands

Introduction

Ellar-CLI is an abstracted tool for the Ellar web framework that helps in the standard project scaffolding and other application commands.

Ellar CLI is built on Click

Installation

if you have ellar install ready

pip install ellar-cli

Usage

To verify ellar-cli is working, run the command below

ellar --help

The 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

ellar-cli's Issues

Generated pyproject.toml is invalid

The error is shown in VS Code from the linter.

Additional properties are not allowed ('ellar' was unexpected)Even Better TOML

The file is parseable:

In [1]: from tomlkit import parse

In [2]: foo="""
   ...: [ellar]
   ...: default = "new_project"
   ...: """

In [3]: parse(foo)
Out[3]: {'ellar': {'default': 'new_project'}}

but trying with validate-pyproject the error again.

$ validate-pyproject pyproject.toml 
Invalid file: pyproject.toml
[ERROR] `data` must not contain {'ellar'} properties

Not sure if it's a real problem, though ellar-cli relies on this nomenclature in pyproject.toml to handle the multi-project if I'm not mistaken.