smartcliapp


Namesmartcliapp JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/smartlegionlab
Summary'Cross-platform library of tools for creating console applications, based on the click library.'
upload_time2024-05-08 05:46:49
maintainerNone
docs_urlNone
authorA.A Suvorov
requires_python>=3.6
licenseBSD 3-Clause License
keywords smartlegionlab click smart cli app console application create cli
VCS
bugtrack_url
requirements setuptools smartprinter click
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # smartcliapp

***

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/smartlegionlab/smartcliapp)](https://github.com/smartlegionlab/smartcliapp/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/smartcliapp?label=pypi%20downloads)](https://pypi.org/project/smartcliapp/)
![GitHub top language](https://img.shields.io/github/languages/top/smartlegionlab/smartcliapp)
[![PyPI](https://img.shields.io/pypi/v/smartcliapp)](https://pypi.org/project/smartcliapp)
[![GitHub](https://img.shields.io/github/license/smartlegionlab/smartcliapp)](https://github.com/smartlegionlab/smartcliapp/blob/master/LICENSE)
[![PyPI - Format](https://img.shields.io/pypi/format/smartcliapp)](https://pypi.org/project/smartcliapp)

***

## Short Description:

___smartcliapp___ - Cross-platform library of tools for creating console applications, based on the click library.

***

Author and developer: ___A.A Suvorov___

[![smartlegiondev@gmail.com](https://img.shields.io/static/v1?label=email:&message=smartlegiondev@gmail.com&color=blue)](mailto:smartlegiondev@gmail.com)

***

## Supported:

- Linux: All.
- Windows: 7/8/10.
- Termux (Android).

***

## What's new?

___smartcliapp v0.4.0___

## Warning!

The package is under active development, so new versions
may not be compatible with the old ones.

***

## Description:

___smartcliapp___ - Cross-platform library of tools for creating console applications, based on the click library.

Use a variety of out-of-the-box tools to create console applications.

Use [click](https://github.com/pallets/click) to develop console applications. 


### Possibilities:

- Displays the title and footer of the application at startup and shutdown. In the center of the console. 
- Display of name, description, copyright, site address in your application.
- Launch the default browser from the console to go to the specified URL, or to your site.
- Storing meta information about your application in one place. 
- Request for action from the user with an instant response to his input without confirmation, consent, refusal, exit from the application (yes/no/exit).
- Various input methods, including non-display input for passwords.
- Operation status output (Ok!/Error!).
- Different ways of displaying information (normal, in the center of the console with filling with characters, in a pager). 
- Top-level ready-made classes containing the necessary tools. 
- Factory for creating objects.

- Use Informer to display meta information.
- Use ClickMan as a toolbox (Printer, InputMan, StatusMan, ActionMan, Launcher).
- Use Factory to create objects individually.

***

## Help:

### Install:

- `pip install smartcliapp`

### Use:

```python
from smartcliapp import Informer, CliManager

class CliMan(Informer):
    tools = CliManager()
    name = 'App Name'
    title = 'App title'
    description = 'App Description'
    copyright = 'App copyright'
    url = 'app url'
    msg = ''
    version = '0.0.0'

```

***

## Disclaimer of liability:

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

***

## Copyright:
    --------------------------------------------------------
    Licensed under the terms of the BSD 3-Clause License
    (see LICENSE for details).
    Copyright © 2018-2024, A.A Suvorov
    All rights reserved.
    --------------------------------------------------------

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/smartlegionlab",
    "name": "smartcliapp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "smartlegionlab, click, smart cli app, console application, create cli",
    "author": "A.A Suvorov",
    "author_email": "smartlegiondev@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d6/6c/a6fb1cda8ced04c36f0d0b6adcf887ca8d1dd0c86ce62a8b1c5444e23d69/smartcliapp-0.4.0.tar.gz",
    "platform": null,
    "description": "# smartcliapp\n\n***\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/smartlegionlab/smartcliapp)](https://github.com/smartlegionlab/smartcliapp/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/smartcliapp?label=pypi%20downloads)](https://pypi.org/project/smartcliapp/)\n![GitHub top language](https://img.shields.io/github/languages/top/smartlegionlab/smartcliapp)\n[![PyPI](https://img.shields.io/pypi/v/smartcliapp)](https://pypi.org/project/smartcliapp)\n[![GitHub](https://img.shields.io/github/license/smartlegionlab/smartcliapp)](https://github.com/smartlegionlab/smartcliapp/blob/master/LICENSE)\n[![PyPI - Format](https://img.shields.io/pypi/format/smartcliapp)](https://pypi.org/project/smartcliapp)\n\n***\n\n## Short Description:\n\n___smartcliapp___ - Cross-platform library of tools for creating console applications, based on the click library.\n\n***\n\nAuthor and developer: ___A.A Suvorov___\n\n[![smartlegiondev@gmail.com](https://img.shields.io/static/v1?label=email:&message=smartlegiondev@gmail.com&color=blue)](mailto:smartlegiondev@gmail.com)\n\n***\n\n## Supported:\n\n- Linux: All.\n- Windows: 7/8/10.\n- Termux (Android).\n\n***\n\n## What's new?\n\n___smartcliapp v0.4.0___\n\n## Warning!\n\nThe package is under active development, so new versions\nmay not be compatible with the old ones.\n\n***\n\n## Description:\n\n___smartcliapp___ - Cross-platform library of tools for creating console applications, based on the click library.\n\nUse a variety of out-of-the-box tools to create console applications.\n\nUse [click](https://github.com/pallets/click) to develop console applications. \n\n\n### Possibilities:\n\n- Displays the title and footer of the application at startup and shutdown. In the center of the console. \n- Display of name, description, copyright, site address in your application.\n- Launch the default browser from the console to go to the specified URL, or to your site.\n- Storing meta information about your application in one place. \n- Request for action from the user with an instant response to his input without confirmation, consent, refusal, exit from the application (yes/no/exit).\n- Various input methods, including non-display input for passwords.\n- Operation status output (Ok!/Error!).\n- Different ways of displaying information (normal, in the center of the console with filling with characters, in a pager). \n- Top-level ready-made classes containing the necessary tools. \n- Factory for creating objects.\n\n- Use Informer to display meta information.\n- Use ClickMan as a toolbox (Printer, InputMan, StatusMan, ActionMan, Launcher).\n- Use Factory to create objects individually.\n\n***\n\n## Help:\n\n### Install:\n\n- `pip install smartcliapp`\n\n### Use:\n\n```python\nfrom smartcliapp import Informer, CliManager\n\nclass CliMan(Informer):\n    tools = CliManager()\n    name = 'App Name'\n    title = 'App title'\n    description = 'App Description'\n    copyright = 'App copyright'\n    url = 'app url'\n    msg = ''\n    version = '0.0.0'\n\n```\n\n***\n\n## Disclaimer of liability:\n\n    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n***\n\n## Copyright:\n    --------------------------------------------------------\n    Licensed under the terms of the BSD 3-Clause License\n    (see LICENSE for details).\n    Copyright \u00a9 2018-2024, A.A Suvorov\n    All rights reserved.\n    --------------------------------------------------------\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License",
    "summary": "'Cross-platform library of tools for creating console applications, based on the click library.'",
    "version": "0.4.0",
    "project_urls": {
        "Documentation": "https://github.com/smartlegionlab/smartcliapp/blob/master/README.md",
        "Homepage": "https://github.com/smartlegionlab",
        "Release notes": "https://github.com/smartlegionlab/smartcliapp/releases"
    },
    "split_keywords": [
        "smartlegionlab",
        " click",
        " smart cli app",
        " console application",
        " create cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ee67232c26c16ff02760e49e9e27157c3333aca2747bf3ab15700fa0e13ea3be",
                "md5": "917c4a125ec18bb869a9e17ecd7951b7",
                "sha256": "158316a1cba4c783dff9d7059228cb7d922d7e3ac67b2bf94e56f65aef3419cd"
            },
            "downloads": -1,
            "filename": "smartcliapp-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "917c4a125ec18bb869a9e17ecd7951b7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 6062,
            "upload_time": "2024-05-08T05:46:47",
            "upload_time_iso_8601": "2024-05-08T05:46:47.559079Z",
            "url": "https://files.pythonhosted.org/packages/ee/67/232c26c16ff02760e49e9e27157c3333aca2747bf3ab15700fa0e13ea3be/smartcliapp-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d66ca6fb1cda8ced04c36f0d0b6adcf887ca8d1dd0c86ce62a8b1c5444e23d69",
                "md5": "50b962971e0bbc1086e3ebd1b6ca6ea6",
                "sha256": "ea9f730cb075ac6a358d5cd6f2c2f0fe894c23204d788da1af795cb7f7cab278"
            },
            "downloads": -1,
            "filename": "smartcliapp-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "50b962971e0bbc1086e3ebd1b6ca6ea6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 5187,
            "upload_time": "2024-05-08T05:46:49",
            "upload_time_iso_8601": "2024-05-08T05:46:49.603949Z",
            "url": "https://files.pythonhosted.org/packages/d6/6c/a6fb1cda8ced04c36f0d0b6adcf887ca8d1dd0c86ce62a8b1c5444e23d69/smartcliapp-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-08 05:46:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "smartlegionlab",
    "github_project": "smartcliapp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "setuptools",
            "specs": [
                [
                    "~=",
                    "57.0.0"
                ]
            ]
        },
        {
            "name": "smartprinter",
            "specs": [
                [
                    "~=",
                    "0.2.0"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    "~=",
                    "8.0.1"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "smartcliapp"
}
        
Elapsed time: 0.24390s