Metadata-Version: 1.2
Name: meteoroid-cli
Version: 0.2.0
Summary: CLI Client app for Meteoroid which is one of FIWARE components
Home-page: http://github.com/OkinawaOpenLaboratory/fiware-meteoroid-cli
Author: Okinawa Open Laboratory
Author-email: fiware-meteoroid-member@okinawaopenlabs.org
Maintainer: Okinawa Open Laboratory
Maintainer-email: fiware-meteoroid-member@okinawaopenlabs.org
License: AGPL v3
Description: Meteoroid CLI
        =============
        
        Overview
        --------
        
        Meteoroid CLI is a command-line-interface for Meteoroid that integrating
        Function as a Service(FaaS) capabilities in FIWARE.
        
        Requirements
        ------------
        
        Python 3.8+ cliff 2.16.0+ pbr 5.4.3+
        
        Usage
        -----
        
        Install meteoroid cli
        ~~~~~~~~~~~~~~~~~~~~~
        
        ::
        
           pip install meteoroid-cli
        
        Export METEOROID_SCHEMA_ENDPOINT (Option)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Defualt endpoint (http://localhost:3000/schema/?format=corejson)
        
        ::
        
           export METEOROID_SCHEMA_ENDPOINT=http://host:port/schema/?format=corejson
        
        Example of use
        ~~~~~~~~~~~~~~
        
        ::
        
           $ meteoroid result show 22
           +---------------+------------------+
           | Field         | Value            |
           +---------------+------------------+
           | id            | 22               |
           | response      | test_response    |
           | logs          | test_logs        |
           | FiwareService | None             |
           | functionId    | test_function_id |
           +---------------+------------------+
        
        Commands
        --------
        
        Funciton
        ~~~~~~~~
        
        =============== ==================
        command         description
        =============== ==================
        function show   Show a function
        function list   Show function list
        function create Create a function
        function update Update a function
        function delete Delete a function
        =============== ==================
        
        Endpoint
        ~~~~~~~~
        
        =============== ==================
        command         description
        =============== ==================
        endpoint show   Show a endpoint
        endpoint list   Show endpoint list
        endpoint create Create endpoint
        endpoint delete Delete endpoint
        =============== ==================
        
        Subscription
        ~~~~~~~~~~~~
        
        =================== ======================
        command             description
        =================== ======================
        subscription show   Show a subscription
        subscription list   Show subscription list
        subscription create Create subscription
        subscription delete Delete subscription
        =================== ======================
        
        Result
        ~~~~~~
        
        =========== ================
        command     description
        =========== ================
        result list Show result list
        result show Show a result
        =========== ================
        
        Schedule
        ~~~~~~~~~~~
        
        =================== ======================
        command             description
        =================== ======================
        Schedule show       Show a Schedule
        Schedule list       Show Schedule list
        Schedule create     Create Schedule
        Schedule delete     Delete Schedule
        =================== ======================
        
        How to use meteoroid
        --------------------
        
        `Meteoroid
        README <https://github.com/OkinawaOpenLaboratory/fiware-meteoroid/blob/master/README.md>`__
        
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Natural Language :: Japanese
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
