Metadata-Version: 2.1
Name: luma
Version: 2.1.1
Summary: A CLI to interact with the Lumavate platform
Home-page: UNKNOWN
Author: Gunnar Norred
Author-email: g.norred@lumavate.com
License: UNKNOWN
Description: # Lumavate CLI
        * To contribute, report bugs, or suggest features, read the contributing guide [here](https://github.com/LabelNexus/lumavate-cli/blob/master/CONTRIBUTING.md).
        
        ## Config Summary:
        * Install CLI
        * Provision CLI credentials
        * Configure CLI
        * Example Commands
        
        ### Installing the CLI from pip:
        ---
        * On Windows, run BASH as admin and omit 'sudo'
        ```
        $ pip3 install luma
        ```
        
        ### Installing the CLI from source:
        ---
        * Clone this repo.
        * CD into the CLI dir and run:
        ```
        $ pip3 install .
        ```
        
        ### CLI support:
        ---
        * The CLI is written for and tested in a BASH shell
        * To get the most of of the CLI, use it with ZSH. This enables extra features such as showing help text during autocompletion
        * To activate autocompletion after install, restart your terminal or source your shell config (Either .zshrc or .bash_profile)
        
        ### Provision CLI Credentials:
        ---
        * In the Lumavate App, navigate to the Lumavate CLI page inside a command center
        * Provisioning CLI credentials will generate credentials for the user you are currently signed in as
        * When running the add profile command, you will have the option to associate the new profile to any \
        organization your user has access to, regardless of the command center you are currently in
        
        ### CLI Config:
        ---
        * Configuring the CLI requires two steps, configuring environments and configuring profiles.
            * **Environments** know how to get and refresh tokens so you stay authorized with the platform as a user.
            * **Profiles** give the user a company context which is required by most of the platform API.
        
        #### CLI Env:
        * To configure the CLI Env, run the generated command from the Lumavate CLI page in the app in your terminal
        * To configure each Env value one by one, run:
        ```
        $ luma env config
        
        Env Name: prod
        App: appUrl
        Token: token
        Audience: audience
        Client id: clientId
        Client secret: clientSecret
        ```
        
        #### CLI Profile:
        * To add a profile to the CLI, run:
        ```
        $ luma profile add
        
        Profile Name: globex
        Env: prod
        Org ID you want to associate with this profile: 11
        ```
        
        ## Running Commands
        ___
        * To list top level commands, run:
        ```
        $ luma
        ```
        * To get help with any command or subcommand, run it without passing in any options or, pass in the --help flag
        * As an example let's create a microservice, create a version, upload a docker image, and start the service
        
        ```
        $ luma microservice add
        Profile: globex
        Name: Auth Service
        Url ref: auth
        | id | name         | urlRef | createdAt         | createdBY          |
        |----|--------------|--------|-------------------|--------------------|
        | 45 | Auth Service | auth   | 10/16/18 20:29:49 | john+doe@gmail.com |
        
        $ luma microservice access --profile globex
        Microservice: auth
        | failed | sharedWith | unsharedWith | resultingGrantees |
        |--------|------------|--------------|-------------------|
        | []     | []         | []           | []                |
        
        $ luma microservice access -p globex --container auth --add "Acme Corp" --add Initech
        | failed | sharedWith   | unsharedWith | resultingGrantees        |
        |--------|--------------|--------------|--------------------------|
        | []     | [{id}, {id}] | []           |  [Acme Corp, 'Initech']  |
        
        $ luma microservice-version add -p globex --version-number 0.1.0 --container-file-path ~/Desktop/auth-service.tar.gz --label prod --port 8080 -c auth
        | id  | actualState | versionNumber | label | createdAt         | createdBy          |
        |-----|-------------|---------------|-------|-------------------|--------------------|
        | 107 | created     | 0.1.0         | prod  | 10/16/18 20:46:44 | john+doe@gmail.com |
        
        $ luma microservice-version start -p globex
        Microservice: auth
        Version: 0.1.0
        Starting Microservice  [####################################]  100%
        ```
        
        ## Additional Information
        ___
        * To contribute, report bugs, or suggest features, read the contributing guide [here](https://github.com/LabelNexus/lumavate-cli/blob/master/CONTRIBUTING.md).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
