Metadata-Version: 2.1
Name: one-cli-plugin-commands
Version: 0.1.1
Summary: This is a one-cli plugin that allow to create new commands during runtime to the CLI.
Home-page: https://github.com/DNXLabs/plugin-commands
Author: DNX Solutions
Author-email: contact@dnx.solutions
License: Apache License 2.0
Description: # plugin-commands
        
        This is a one-cli plugin that allow to create new commands during runtime to the CLI.
        
        ![Build](https://github.com/DNXLabs/plugin-commands/workflows/Build/badge.svg)
        [![PyPI](https://badge.fury.io/py/plugin-commands.svg)](https://pypi.python.org/pypi/one-cli-plugin-commands/)
        [![LICENSE](https://img.shields.io/github/license/DNXLabs/plugin-commands)](https://github.com/DNXLabs/plugin-commands/blob/master/LICENSE)
        
        ## Configuration
        
        ```yaml
        # one.yaml
        required_version: ">= 0.6.5"
        
        plugins:
          commands:
            source: https://github.com/DNXLabs/plugin-commands/archive/0.1.0.tar.gz
        
        commands:
        - name: install
          command: 'npm install'
          volumes: ['.:/work']
          help: 'npm install'
        - name: build
          command: 'npm run build'
          volumes: ['.:/work']
          help: 'npm run build'
        - name: start
          volumes: ['.:/work']
          command: 'npm start'
          ports: ['4100:4100']
          help: 'npm start'
          environment: ['TEST': 'test']
        ```
        
        ## Usage
        
        ```bash
        one install
        one build
        one start
        ```
        
        ## Parameters
        
        ```yaml
        - name: <command_name>
          image: <string(docker_image)> # default to
          entrypoint: <string(entrypoint)> # default to None
          volumes: <list(volumes)> # ['.:/work', '.:/app']
          command: <string(command)>
          ports: <list(ports)>  # ['3000:3000', '4100:4100']
          environment: <list(environments)> # ['ENV': 'env']
          help: <string(help)>
        ```
        
        #### Python Virtual Environment
        
        ```bash
        # Create environment
        python3 -m venv env
        
        # To activate the environment
        source env/bin/activate
        
        # When you finish you can exit typing
        deactivate
        ```
        
        ## Development
        
        #### Dependencies
        
        - Python 3
        
        #### Install dependencies
        
        ```bash
        pip3 install --editable .
        ```
        
        ## Author
        
        Managed by [DNX Solutions](https://github.com/DNXLabs).
        
        ## License
        
        Apache 2 Licensed. See [LICENSE](https://github.com/DNXLabs/plugin-commands/blob/master/LICENSE) for full details.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
