Readlike
========
A Python module that provides `GNU Readline`_-like line editing functions (the
default Emacs-style ones). If you just want to use Readline, use the readline_
package in the standard library--but this package allows access to those
capabilties in settings outside of a standard CLI.
Currently, all stateless Readline commands are implemented. This means that
yanking and history are not supported.
This module is especially well-suited to interfacing with Urwid_ due to a
shared syntax for describing key inputs.
Installation
------------
Install or upgrade to the latest version from PyPI_::
[sudo] pip install -U readlike
Quick example
-------------
Transpose words::
>>> import readlike
>>> readlike.edit('perilous siege', 9, 'meta t')
('siege perilous', 14)
Commands
--------
Implemented commands and their correspondings keys are as follows::
backward-char ctrl b, left
backward-delete-char ctrl h, backspace
backward-kill-word ctrl meta h, meta backspace
backward-word meta b, meta left
beginning-of-line ctrl a, home
capitalize-word meta c
delete-char ctrl d, delete
delete-horizontal-space meta \
downcase-word meta l
end-of-line ctrl e, end
forward-char ctrl f, right
forward-word meta f, meta right
kill-line ctrl k
kill-word meta d, meta delete
transpose-chars ctrl t
transpose-words meta t
unix-line-discard ctrl u
unix-word-rubout ctrl w
upcase-word meta u
For more information about each command, see readline(3) or see the doc
strings in readlike.py_.
Projects using Readlike
-----------------------
- hangups_
.. _GNU Readline: http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html
.. _readline: https://docs.python.org/3/library/readline.html
.. _PyPI: https://pypi.python.org/pypi/readlike
.. _Urwid: http://urwid.org/
.. _readlike.py: https://github.com/jangler/readlike/blob/master/readlike.py
.. _hangups: https://github.com/tdryer/hangups
Raw data
{
"_id": null,
"home_page": "https://github.com/jangler/readlike",
"name": "readlike",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "line editing",
"author": "Brandon Mulcahy",
"author_email": "brandon@lightcones.net",
"download_url": "https://files.pythonhosted.org/packages/2b/2d/8b281b3c2c14efd4105f90a83d886a69c8a1f6d6c2c20f1c55a8d65822ce/readlike-0.1.3.tar.gz",
"platform": "",
"description": "Readlike\n========\n\nA Python module that provides `GNU Readline`_-like line editing functions (the\ndefault Emacs-style ones). If you just want to use Readline, use the readline_\npackage in the standard library--but this package allows access to those\ncapabilties in settings outside of a standard CLI.\n\nCurrently, all stateless Readline commands are implemented. This means that\nyanking and history are not supported.\n\nThis module is especially well-suited to interfacing with Urwid_ due to a\nshared syntax for describing key inputs.\n\nInstallation\n------------\n\nInstall or upgrade to the latest version from PyPI_::\n\n\t[sudo] pip install -U readlike\n\nQuick example\n-------------\n\nTranspose words::\n\n\t>>> import readlike\n\t>>> readlike.edit('perilous siege', 9, 'meta t')\n\t('siege perilous', 14)\n\nCommands\n--------\n\nImplemented commands and their correspondings keys are as follows::\n\n backward-char ctrl b, left\n backward-delete-char ctrl h, backspace\n backward-kill-word ctrl meta h, meta backspace\n backward-word meta b, meta left\n beginning-of-line ctrl a, home\n capitalize-word meta c\n delete-char ctrl d, delete\n delete-horizontal-space meta \\\n downcase-word meta l\n end-of-line ctrl e, end\n forward-char ctrl f, right\n forward-word meta f, meta right\n kill-line ctrl k\n kill-word meta d, meta delete\n transpose-chars ctrl t\n transpose-words meta t\n unix-line-discard ctrl u\n unix-word-rubout ctrl w\n upcase-word meta u\n\nFor more information about each command, see readline(3) or see the doc\nstrings in readlike.py_.\n\nProjects using Readlike\n-----------------------\n\n- hangups_\n\n.. _GNU Readline: http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html\n.. _readline: https://docs.python.org/3/library/readline.html\n.. _PyPI: https://pypi.python.org/pypi/readlike\n.. _Urwid: http://urwid.org/\n.. _readlike.py: https://github.com/jangler/readlike/blob/master/readlike.py\n.. _hangups: https://github.com/tdryer/hangups\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GNU Readline-like line editing module",
"version": "0.1.3",
"split_keywords": [
"line",
"editing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7102d639167c3ed84b9c3040bc99ed97be67796b53635f0c4f23392918428324",
"md5": "c518ab884431859ba413d8cff219b858",
"sha256": "a87a179ac7badc174883d88baddb37a5f8cbb4fe533a5fa2ffc3563b14fe2601"
},
"downloads": -1,
"filename": "readlike-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c518ab884431859ba413d8cff219b858",
"packagetype": "bdist_wheel",
"python_version": "3.6",
"requires_python": null,
"size": 4641,
"upload_time": "2018-05-29T21:07:44",
"upload_time_iso_8601": "2018-05-29T21:07:44.546625Z",
"url": "https://files.pythonhosted.org/packages/71/02/d639167c3ed84b9c3040bc99ed97be67796b53635f0c4f23392918428324/readlike-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b2d8b281b3c2c14efd4105f90a83d886a69c8a1f6d6c2c20f1c55a8d65822ce",
"md5": "95fe69ddd0f17ba88e63419bb4310ea1",
"sha256": "4486ba5f1c1770dc6458316ecb95ea12e1ba7f59f328804fa17a8212b743fc08"
},
"downloads": -1,
"filename": "readlike-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "95fe69ddd0f17ba88e63419bb4310ea1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5023,
"upload_time": "2018-05-29T21:07:43",
"upload_time_iso_8601": "2018-05-29T21:07:43.243574Z",
"url": "https://files.pythonhosted.org/packages/2b/2d/8b281b3c2c14efd4105f90a83d886a69c8a1f6d6c2c20f1c55a8d65822ce/readlike-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-05-29 21:07:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jangler",
"github_project": "readlike",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "readlike"
}
JSON
