pyreadline3


Namepyreadline3 JSON
Version 3.5.4 PyPI version JSON
download
home_pageNone
SummaryA python implementation of GNU readline.
upload_time2024-09-19 02:40:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD
keywords readline pyreadline pyreadline3
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyreadline3

[![PyPi Badge](https://img.shields.io/pypi/v/pyreadline3)](https://pypi.org/project/pyreadline3/)
![Publish](https://github.com/pyreadline3/pyreadline3/workflows/Publish/badge.svg)
![Test](https://github.com/pyreadline3/pyreadline3/workflows/Test/badge.svg)
[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=week&units=international_system&left_color=black&right_color=orange&left_text=Last%20Week)](https://pepy.tech/project/pyreadline3)
[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=month&units=international_system&left_color=black&right_color=orange&left_text=Month)](https://pepy.tech/project/pyreadline3)
[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=total&units=international_system&left_color=black&right_color=orange&left_text=Total)](https://pepy.tech/project/pyreadline3)

The `pyreadline3` package is based on the stale package `pyreadline` located
[here](https://github.com/pyreadline/pyreadline).
The original `pyreadline` package is a Python implementation of GNU `readline`
functionality.
It is based on the `ctypes` based UNC `readline` package by Gary Bishop.
It is not complete.
It has been tested for use with Windows 10.

Version 3.4+ of pyreadline3 runs on Python 3.8+.

`pyreadline3` is available on PyPI and can be installed with

    pip install pyreadline3

## Features

- keyboard text selection and copy/paste
- Shift-arrowkeys for text selection
- Control-c can be used for copy activate with allow_ctrl_c(True) in config file
- Double tapping ctrl-c will raise a KeyboardInterrupt, use ctrl_c_tap_time_interval(x)
- where x is your preferred tap time window, default 0.3 s.
- paste pastes first line of content on clipboard.
- ipython_paste, pastes tab-separated data as list of lists or numpy array if all data is numeric
- paste_mulitline_code pastes multi line code, removing any empty lines.

The latest development version is always available at the project git
[repository](https://github.com/pyreadline3/pyreadline3)

## Development

To clone the library for development:

    git clone git@github.com:pyreadline3/pyreadline3.git

or

    git clone https://github.com/pyreadline3/pyreadline3.git

### Build The Virtual Environment

The current earliest Python version supported is `3.8`. You need to be able to create a virtual environment at this version to make sure any changes you make is combatible.

If you are using `conda`:

    conda create --prefix=.venv python=3.8 --yes

If you are using `venv`, make sure you have the right base package:

    >> python --version
    Python 3.8.x

Once you verify your base Python, you can then create a virtual environment using:

    virtualenv -p py3.8 .venv

### Setup

Once you have created your virtual environment and made sure it is active in your current command line:

    pip install -e .[dev]

This should all the dependencies you need for developing into the library and also allow you to run the unit tests:

    pytest

### Debugging

 WIP

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyreadline3",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Bassem Girgis <brgirgis@gmail.com>",
    "keywords": "readline, pyreadline, pyreadline3",
    "author": null,
    "author_email": "Bassem Girgis <brgirgis@gmail.com>, Jorgen Stenarson <jorgen.stenarson@kroywen.se>, Gary Bishop <unknwon@unknown.com>, Jack Trainor <unknwon@unknown.com>",
    "download_url": "https://files.pythonhosted.org/packages/0f/49/4cea918a08f02817aabae639e3d0ac046fef9f9180518a3ad394e22da148/pyreadline3-3.5.4.tar.gz",
    "platform": null,
    "description": "# pyreadline3\r\n\r\n[![PyPi Badge](https://img.shields.io/pypi/v/pyreadline3)](https://pypi.org/project/pyreadline3/)\r\n![Publish](https://github.com/pyreadline3/pyreadline3/workflows/Publish/badge.svg)\r\n![Test](https://github.com/pyreadline3/pyreadline3/workflows/Test/badge.svg)\r\n[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=week&units=international_system&left_color=black&right_color=orange&left_text=Last%20Week)](https://pepy.tech/project/pyreadline3)\r\n[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=month&units=international_system&left_color=black&right_color=orange&left_text=Month)](https://pepy.tech/project/pyreadline3)\r\n[![Downloads](https://static.pepy.tech/personalized-badge/pyreadline3?period=total&units=international_system&left_color=black&right_color=orange&left_text=Total)](https://pepy.tech/project/pyreadline3)\r\n\r\nThe `pyreadline3` package is based on the stale package `pyreadline` located\r\n[here](https://github.com/pyreadline/pyreadline).\r\nThe original `pyreadline` package is a Python implementation of GNU `readline`\r\nfunctionality.\r\nIt is based on the `ctypes` based UNC `readline` package by Gary Bishop.\r\nIt is not complete.\r\nIt has been tested for use with Windows 10.\r\n\r\nVersion 3.4+ of pyreadline3 runs on Python 3.8+.\r\n\r\n`pyreadline3` is available on PyPI and can be installed with\r\n\r\n    pip install pyreadline3\r\n\r\n## Features\r\n\r\n- keyboard text selection and copy/paste\r\n- Shift-arrowkeys for text selection\r\n- Control-c can be used for copy activate with allow_ctrl_c(True) in config file\r\n- Double tapping ctrl-c will raise a KeyboardInterrupt, use ctrl_c_tap_time_interval(x)\r\n- where x is your preferred tap time window, default 0.3 s.\r\n- paste pastes first line of content on clipboard.\r\n- ipython_paste, pastes tab-separated data as list of lists or numpy array if all data is numeric\r\n- paste_mulitline_code pastes multi line code, removing any empty lines.\r\n\r\nThe latest development version is always available at the project git\r\n[repository](https://github.com/pyreadline3/pyreadline3)\r\n\r\n## Development\r\n\r\nTo clone the library for development:\r\n\r\n    git clone git@github.com:pyreadline3/pyreadline3.git\r\n\r\nor\r\n\r\n    git clone https://github.com/pyreadline3/pyreadline3.git\r\n\r\n### Build The Virtual Environment\r\n\r\nThe current earliest Python version supported is `3.8`. You need to be able to create a virtual environment at this version to make sure any changes you make is combatible.\r\n\r\nIf you are using `conda`:\r\n\r\n    conda create --prefix=.venv python=3.8 --yes\r\n\r\nIf you are using `venv`, make sure you have the right base package:\r\n\r\n    >> python --version\r\n    Python 3.8.x\r\n\r\nOnce you verify your base Python, you can then create a virtual environment using:\r\n\r\n    virtualenv -p py3.8 .venv\r\n\r\n### Setup\r\n\r\nOnce you have created your virtual environment and made sure it is active in your current command line:\r\n\r\n    pip install -e .[dev]\r\n\r\nThis should all the dependencies you need for developing into the library and also allow you to run the unit tests:\r\n\r\n    pytest\r\n\r\n### Debugging\r\n\r\n WIP\r\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "A python implementation of GNU readline.",
    "version": "3.5.4",
    "project_urls": {
        "Changelog": "https://github.com/pyreadline3/pyreadline3/blob/master/doc/ChangeLog",
        "Documentation": "https://github.com/pyreadline3/pyreadline3",
        "Homepage": "https://github.com/pyreadline3/pyreadline3",
        "Issues": "https://github.com/pyreadline3/pyreadline3/issues",
        "Repository": "https://github.com/pyreadline3/pyreadline3.git"
    },
    "split_keywords": [
        "readline",
        " pyreadline",
        " pyreadline3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5adc491b7661614ab97483abf2056be1deee4dc2490ecbf7bff9ab5cdbac86e1",
                "md5": "3436bf88195d50e33be4b9262b7f0463",
                "sha256": "eaf8e6cc3c49bcccf145fc6067ba8643d1df34d604a1ec0eccbf7a18e6d3fae6"
            },
            "downloads": -1,
            "filename": "pyreadline3-3.5.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3436bf88195d50e33be4b9262b7f0463",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 83178,
            "upload_time": "2024-09-19T02:40:08",
            "upload_time_iso_8601": "2024-09-19T02:40:08.598860Z",
            "url": "https://files.pythonhosted.org/packages/5a/dc/491b7661614ab97483abf2056be1deee4dc2490ecbf7bff9ab5cdbac86e1/pyreadline3-3.5.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0f494cea918a08f02817aabae639e3d0ac046fef9f9180518a3ad394e22da148",
                "md5": "395610f91cff4cdc624fb90f0d8c9826",
                "sha256": "8d57d53039a1c75adba8e50dd3d992b28143480816187ea5efbd5c78e6c885b7"
            },
            "downloads": -1,
            "filename": "pyreadline3-3.5.4.tar.gz",
            "has_sig": false,
            "md5_digest": "395610f91cff4cdc624fb90f0d8c9826",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 99839,
            "upload_time": "2024-09-19T02:40:10",
            "upload_time_iso_8601": "2024-09-19T02:40:10.062732Z",
            "url": "https://files.pythonhosted.org/packages/0f/49/4cea918a08f02817aabae639e3d0ac046fef9f9180518a3ad394e22da148/pyreadline3-3.5.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-19 02:40:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pyreadline3",
    "github_project": "pyreadline3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyreadline3"
}
        
Elapsed time: 0.53804s