Metadata-Version: 2.1
Name: trzsz-libs
Version: 0.1.3
Summary: trzsz is a simple file transfer tools, similar to lrzsz ( rz / sz ) but compatible with tmux, which works with iTerm2 and has a nice progress bar.
Home-page: https://trzsz.github.io
Author: Lonny Wong
Author-email: lonnywong@qq.com
License: MIT License
Description: # trzsz
        
        trzsz is a simple file transfer tools, similar to lrzsz ( rz / sz ) but compatible with tmux.
        
        which works with iTerm2 and has a nice progress bar.
        
        Website: [https://trzsz.github.io](https://trzsz.github.io)
        
        [![MIT License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://choosealicense.com/licenses/mit/)
        [![PyPI trzsz](https://img.shields.io/pypi/v/trzsz?style=flat)](https://pypi.python.org/pypi/trzsz/)
        
        
        ## Why?
        
        I love to use [iTerm2 integrating with tmux](https://iterm2.com/documentation-tmux-integration.html) to manage terminal sessions.
        
        Sometimes, I need to transfer some files between my laptop and the remote server.
        
        Considering `laptop --> hostA --> hostB --> docker --> tmux ` , using scp to transfer files is inconvenience.
        
        [Tmux](https://github.com/tmux/tmux) is not going to support lrzsz ( rz / sz ) ( [906](https://github.com/tmux/tmux/issues/906), [1439](https://github.com/tmux/tmux/issues/1439) ), and I found out that creating a new file transfer tools is much easier than patching tmux.
        
        Additionally, [iTerm2-zmodem](https://github.com/RobberPhex/iTerm2-zmodem) is not supporting a progress bar. Is there something wrong happened or just need more time?
        
        
        ## Requirements
        * [Python](https://www.python.org/)
          * Python’s standard library is good enough.
        * [iTerm2](https://iterm2.com/index.html)
          * [Tmux Integration](https://iterm2.com/documentation-tmux-integration.html) and [Coprocesses](https://iterm2.com/documentation-coprocesses.html) are so cool.
          * `btw` without tmux works too.
        * [zenity](https://github.com/ncruces/zenity)
          * Optional for a nice progress bar.
        
        
        ## Installation
        
        ### Server side
        
        * Install [trzsz-svr](https://pypi.org/project/trzsz-svr)
          * `python3 -m pip install --upgrade trzsz-svr`
        
        
        ### Client side
        
        * Install [trzsz-iterm2](https://pypi.org/project/trzsz-iterm2)
          * `python3 -m pip install --upgrade trzsz-iterm2`
        
        * Install [iTerm2](https://iterm2.com/index.html) and create a [Trigger](https://iterm2.com/documentation-triggers.html) as follows.
        
          | Name | Value |
          | ---- | ---- |
          | Regular Expression | `:(:TRZSZ:TRANSFER:[SR]:\d+\.\d+\.\d+)` |
          | Action | `Run Silent Coprocess` |
          | Parameters | `/usr/local/bin/trzsz-iterm2 \1` |
          | Enabled | ✅ |
        
          ![iTerm2 Trigger configuration](https://trzsz.github.io/images/config.png)
        
        
        * `Optional` install [zenity](https://github.com/ncruces/zenity) for a nice progress bar.
          * should be placed at `/usr/local/bin/zenity`
        
        
        ## Manual
        
        * `trz` upload files to remote server
          ```
          usage: trz [-h] [-v] [path]
        
          Receive file(s), similar to rz but compatible with tmux.
        
          positional arguments:
            path           Path to save file(s). (default: current directory)
        
          optional arguments:
            -h, --help     show this help message and exit
            -v, --version  show program's version number and exit
          ```
        
        * `tsz` download files from remote server
          ```
          usage: tsz [-h] [-v] file [file ...]
        
          Send file(s), similar to sz but compatible with tmux.
        
          positional arguments:
            file           File(s) to be sent.
        
          optional arguments:
            -h, --help     show this help message and exit
            -v, --version  show program's version number and exit
          ```
        
        ## Screenshot
        
        * Upload files to remote server.
        
          ![Upload files looks good](https://trzsz.github.io/images/upload.gif)
        
        * Download files from remote server.
        
          ![Download files looks good](https://trzsz.github.io/images/download.gif)
        
        
        ## Contact
        
        Feel free to email me <lonnywong@qq.com> (same as my PayPal account, just in case you want to deduct🤑).
        
Keywords: trzsz trz tsz lrzsz rz sz tmux iTerm2 progressbar
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
