Metadata-Version: 1.1
Name: libtmux
Version: 0.3
Summary: Python API for tmux servers, sessions, windows and panes
Home-page: http://github.com/tony/libtmux/
Author: Tony Narlock
Author-email: tony@git-pull.com
License: BSD
Download-URL: https://pypi.python.org/pypi/libtmux
Description: libtmux - library for managing tmux workspaces
        
        |pypi| |docs| |build-status| |coverage| |license|
        
        install
        -------
        
        .. code-block:: sh
        
            $ [sudo] pip install libtmux
            $ tmux new-session -n libtmux_wins -s a_libtmux_session
        
        import and get the server object
        --------------------------------
        
        .. code-block:: python
        
            >>> import libtmux
            >>> server = libtmux.Server()
            >>> server
            <libtmux.server.Server object at 0x7fbd622c1dd0>
        
        list sessions::
        
            >>> server.list_sessions()
            [Session($3 a_libtmux_session), Session($1 libtmux)]
        
        find session::
        
            >>> server.getById('$3')
            Session($3 a_libtmux_session)
        
        find session by dict lookup::
        
            >>> server.findWhere({ "session_name": "a_libtmux_session" })
            Session($3 a_libtmux_session)
        
        assign session to ``session``::
        
            >>> session = server.findWhere({ "session_name": "a_libtmux_session" })
        
        play with session::
        
            >>> session.new_window(attach=False, window_name="ha in the bg")
            Window(@8 2:ha in the bg, Session($3 a_libtmux_session))
            >>> session.kill_window("ha in")
            >>> session.new_window(attach=False, window_name="ha in the bg")
            Window(@11 3:ha in the bg, Session($3 a_libtmux_session))
            >>> session.kill_window('@12')
            >>> window = session.new_window(attach=False, window_name="check this out")
            >>> window.kill_window()
        
        grab remaining tmux window::
        
            >>> window = session.attached_window()
            >>> window.split_window(attach=False)
            Pane(%23 Window(@10 1:libtmux_wins, Session($3 a_libtmux_session)))
        
        rename window::
        
            >>> window.rename_window('libtmuxower')
            Window(@10 1:libtmuxower, Session($3 a_libtmux_session))
        
        create panes by splitting window::
        
            >>> pane = window.split_window()
            >>> pane = window.split_window(attach=False)
            >>> pane.select_pane()
            >>> window = session.new_window(attach=False, window_name="test")
            >>> pane = window.split_window(attach=False)
        
        send key strokes to panes::
        
            >>> pane.send_keys('echo hey send now')
        
            >>> pane.send_keys('echo hey', enter=False)
            >>> pane.enter()
        
        Project details
        ---------------
        
        ==============  ==========================================================
        tmux support    1.8, 1.9a, 2.0, 2.1, 2.2
        python support  2.6, 2.7, >= 3.3
        Source          https://github.com/tony/libtmux
        Docs            http://libtmux.rtfd.org
        API             http://libtmux.readthedocs.org/en/latest/api.html
        Changelog       http://libtmux.readthedocs.org/en/latest/history.html
        Issues          https://github.com/tony/libtmux/issues
        Travis          http://travis-ci.org/tony/libtmux
        Test Coverage   https://coveralls.io/r/tony/libtmux
        pypi            https://pypi.python.org/pypi/libtmux
        Open Hub        https://www.openhub.net/p/libtmux
        License         `BSD`_.
        git repo        .. code-block:: bash
        
                            $ git clone https://github.com/tony/libtmux.git
        install stable  .. code-block:: bash
        
                            $ sudo pip install libtmux
        install dev     .. code-block:: bash
        
                            $ git clone https://github.com/tony/libtmux.git libtmux
                            $ cd ./libtmux
                            $ virtualenv .venv
                            $ source .venv/bin/activate
                            $ pip install -e .
        
                        See the `developing and testing`_ page in the docs for
                        more.
        tests           .. code-block:: bash
        
                            $ make test
        ==============  ==========================================================
        
        .. _BSD: http://opensource.org/licenses/BSD-3-Clause
        .. _developing and testing: http://libtmux.readthedocs.org/en/latest/developing.html
        .. _installing bash completion: http://libtmux.readthedocs.org/en/latest/quickstart.html#bash-completion
        .. _Developing and Testing: http://libtmux.readthedocs.org/en/latest/developing.html
        .. _Issues tracker: https://github.com/tony/libtmux/issues
        
        .. |pypi| image:: https://img.shields.io/pypi/v/libtmux.svg
            :alt: Python Package
            :target: http://badge.fury.io/py/libtmux
        
        .. |build-status| image:: https://img.shields.io/travis/tony/libtmux.svg
           :alt: Build Status
           :target: https://travis-ci.org/tony/libtmux
        
        .. |coverage| image:: https://img.shields.io/coveralls/tony/libtmux.svg
            :alt: Code Coverage
            :target: https://coveralls.io/r/tony/libtmux?branch=master
            
        .. |license| image:: https://img.shields.io/github/license/tony/libtmux.svg
            :alt: License 
        
        .. |docs| image:: https://readthedocs.org/projects/libtmux/badge/?version=latest
            :alt: Documentation Status
            :scale: 100%
            :target: https://readthedocs.org/projects/libtmux/
        
Keywords: libtmux
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Shells
