Metadata-Version: 1.0
Name: takumi-cli
Version: 0.1.1
Summary: Takumi service framework command line toolkit
Home-page: https://github.com/elemecreativelab/takumi-cli
Author: Eleme Lab
Author-email: imaralla@icloud.com
License: UNKNOWN
Description: takumi-cli: Takumi command line toolkit
        =======================================
        
        .. image:: https://travis-ci.org/elemepi/takumi-cli.svg?branch=master
            :target: https://travis-ci.org/elemepi/takumi-cli
        
        Command line tool for managing Takumi services.
        
        Install
        -------
        
        .. code:: bash
        
            $ pip install takumi-cli
        
        Usage
        -----
        
        .. code-block:: bash
        
            $ takumi -h
        
        Run service
        ~~~~~~~~~~~
        
        .. code-block:: bash
        
            $ takumi serve
        
        Deploy an application
        ~~~~~~~~~~~~~~~~~~~~~
        
        To deploy using ansible, extra requirements should be installed:
        
        .. code:: bash
        
            $ pip install takumi-cli[deploy]
        
        
        Add ``deploy`` entry to *app.yaml*:
        
        .. code:: yaml
        
            deploy:
              vars:
                version: HEAD
              targets:
                testing:
                  - localhost
                  - testing.com
                prod:
                  - app.prod
        
        Using the following command to deploy:
        
        .. code-block:: bash
        
            $ takumi deploy testing -t deploy
        
        The deploy command is implemented using `ansible <https://github.com/ansible/ansible>`_.
        
        To deploy crontab, add the following config to *app.yaml*
        
        .. code-block:: yaml
        
            deploy:
              crontab:
                - name: check dirs
                  schedule: "0 5,2 * * *"
                  job: 'ls -alh > /dev/null'
        
                - name: say hello
                  schedule:
                    minute: 0
                    hour: 5,2
                  job: 'scripts/say_hello.py'
        
        then run:
        
        .. code-block:: bash
        
            $ takumi deploy <target> -t cron
        
        Cron jobs are run under app working directory ``/srv/{{ app_name }}``.
        
        Start an interactive shell
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To start an IPython shell, extra requirements should be installed:
        
        .. code:: bash
        
            $ pip install takumi-cli[shell]
        
        Start the shell:
        
        .. code:: bash
        
            $ takumi shell -t <host> -- <ipython args>
        
Platform: UNKNOWN
