{ "info": { "author": "Jakub Jirutka", "author_email": "jakub@jirutka.cz", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Programming Language :: Python", "Topic :: Utilities" ], "description": "Remote Sublime Text (rsub)\n==========================\n\n|version| |downloads|\n\nWith ``rsub`` you can open and edit files from a remote machine (you\u2019re\nconnected via SSH) in your local `Sublime\nText `__\\ \\* or `TextMate\n2 `__. No need to setup a shared\nfilesystem or anything like that, just a `SSH\ntunnel <#setting-up-the-connection>`__!\n\nThis script is a port of the original\n`rmate `__.\n\n*\\* To get it work on Sublime Text you need\n`rsub-plugin `__.*\n\nInstallation\n------------\n\nThe rsub requires Python 2.7+ or 3.\u00d7 and module\n`docopt `__ 0.4.0+.\n\nSystem-wide\n~~~~~~~~~~~\n\nInstall from PyPi system-wide:\n\n::\n\n sudo pip install rsub\n\n\u2026or manually:\n\n::\n\n git clone git@github.com:jirutka/rsub-client.git\n cd rsub-client\n sudo ./setup.py install\n cd .. && rm -Rf rsub-client\n\nLocally\n~~~~~~~\n\nIf you don\u2019t have root access to the system, or just don\u2019t want to\ninstall rsub system-wide, then you can tell ``pip`` or ``setup.py`` to\ninstall rsub into your home directory (namely ``~/.local``):\n\n::\n\n pip install --user rsub\n\n\u2026or manually:\n\n::\n\n git clone git@github.com:jirutka/rsub-client.git\n cd rsub-client\n ./setup.py --user install\n cd .. && rm -Rf rsub-client\n\nThe ``rsub`` script should be installed in ``~/.local/bin``. If you want\nto make it accessible from anywhere, add this directory to your ``PATH``\n(choose one according to shell you\u2019re using):\n\n::\n\n echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.bashrc # bash\n echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.zshrc # zsh\n echo 'set -x PATH $HOME/.local/bin $PATH' >> ~/.config/fish/config.fish # fish\n\nUsage\n-----\n\nYou can use ``rsub --help`` to see the usage:\n\n::\n\n Usage:\n rsub [options] [-l NUM] [-m NAME] [-t TYPE] -\n rsub [options] [-l NUM...] [-m NAME...] [-t TYPE...] FILE...\n\n - Read from the standard input.\n FILE File to open (will be created if does not exist yet).\n\n -l NUM --line=NUM Place caret on line [NUM] after loading the file.\n -m NAME --name=NAME The display name shown in editor.\n -t TYPE --type=TYPE Treat file as having [TYPE] (e.g. rb, py, md).\n\n Options:\n -H HOST --host=HOST Connect to host. Use 'auto' to detect the host from SSH.\n -p PORT --port=PORT Port number to use for connection.\n -w --wait Wait for file(s) to be closed by the editor.\n -f --force Open even if the file is not writable.\n -v --verbose Verbose logging messages.\n -h --help Show this message and exit.\n --version Show version and exit.\n\nDefault options can be set in ``/etc/rsubrc`` and ``~/.rsubrc`` (or\n``/etc/rmate.rc`` and ``~/.rmate.rc`` for compatibility with original\nrmate):\n\n::\n\n host = auto # prefer host from SSH_CONNECTION over localhost\n port = 52698\n\nYou can also set the ``RSUB_HOST`` and ``RSUB_PORT`` (or ``RMATE_HOST``\nand ``RMATE_PORT``) environment variables.\n\nSetting up the connection\n-------------------------\n\nTo do its job, ``rsub`` needs a connection back to your computer so that\nit can talk to Sublime Text or TextMate. There are multiple ways you can\naccomplish this, but probably the best way is to use a reverse SSH\ntunnel:\n\n::\n\n ssh -R 52698:localhost:52698 example.com\n\nThe ``-R`` option sets up a reverse tunnel. The first ``52698`` names a\nport on the remote. It will be connected to ``localhost:52698`` or the\nsame port on the connecting box. That port number is the default for\nSublime Text, TextMate 2 and rsub. To test things out, launch Sublime\nText or TextMate 2 on your local machine and run a command like this on\nthe remote:\n\n::\n\n rsub test.md\n\nAfter you verify that things are working, feel free to update your SSH\nsetting to automatically setup the tunnel without you needing to supply\nthe ``-R`` arguments all the time.\n\nFor a single server just add an entry like the following to your\n``~/.ssh/config``:\n\n::\n\n Host example.com\n RemoteForward 52698 localhost:52698\n\nIf you want to make those settings the default for all of your servers,\nuse the wildcard host:\n\n::\n\n Host *\n RemoteForward 52698 localhost:52698\n\nMore information can be found in `this blog\npost `__.\n\nLicense\n-------\n\nThis project is licensed under `MIT\nlicense `__.\n\n.. |version| image:: https://img.shields.io/pypi/v/rsub.svg?style=flat\n :target: https://pypi.python.org/pypi/rsub\n.. |downloads| image:: https://img.shields.io/pypi/dm/rsub.svg?style=flat\n :target: https://pypi.python.org/pypi/rsub", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jirutka/rsub-client", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "rsub", "package_url": "https://pypi.org/project/rsub/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rsub/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/jirutka/rsub-client" }, "release_url": "https://pypi.org/project/rsub/1.0.2/", "requires_dist": null, "requires_python": null, "summary": "Open and edit files from a remote machine in your local Sublime Text or TextMate 2.", "version": "1.0.2" }, "last_serial": 1844270, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "4ae928d64cdabdd0d3d8694c2adcbe3e", "sha256": "c8f006c7926e759659b5e25ffe88c558f44d5164c5428b317d7443fde17e69ff" }, "downloads": -1, "filename": "rsub-1.0.0.tar.gz", "has_sig": false, "md5_digest": "4ae928d64cdabdd0d3d8694c2adcbe3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8341, "upload_time": "2014-08-31T22:14:16", "url": "https://files.pythonhosted.org/packages/5b/ed/5e034500e2e1c015946f76659b9d19c4490a99915d84d2b8daa50b968ca2/rsub-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "d50b35bef521817d90ff8c0cb300881e", "sha256": "23071e31a1df2609be7a28ff39a839b068f5505c1cb57a7a138636014b7529da" }, "downloads": -1, "filename": "rsub-1.0.1.tar.gz", "has_sig": false, "md5_digest": "d50b35bef521817d90ff8c0cb300881e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8449, "upload_time": "2015-08-10T11:52:39", "url": "https://files.pythonhosted.org/packages/0c/8d/053a5314429d36458c6a176fd6a3e35d4e685bab7a476defad4235449bf3/rsub-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "42a901680ab7a00126170a1c822d0b3f", "sha256": "23480f2f7505f96ce8468267cbd2e83bf8b6271c7fc617b56816b9ad45955efe" }, "downloads": -1, "filename": "rsub-1.0.2.tar.gz", "has_sig": false, "md5_digest": "42a901680ab7a00126170a1c822d0b3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8436, "upload_time": "2015-12-03T01:20:52", "url": "https://files.pythonhosted.org/packages/67/31/93e2f86ce5e04646ac4aa55c5992f7c170e8e217336abfca84f600b7bb5a/rsub-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "42a901680ab7a00126170a1c822d0b3f", "sha256": "23480f2f7505f96ce8468267cbd2e83bf8b6271c7fc617b56816b9ad45955efe" }, "downloads": -1, "filename": "rsub-1.0.2.tar.gz", "has_sig": false, "md5_digest": "42a901680ab7a00126170a1c822d0b3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8436, "upload_time": "2015-12-03T01:20:52", "url": "https://files.pythonhosted.org/packages/67/31/93e2f86ce5e04646ac4aa55c5992f7c170e8e217336abfca84f600b7bb5a/rsub-1.0.2.tar.gz" } ] }