110 lines
4.4 KiB
Plaintext
110 lines
4.4 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: pyreadline3
|
|
Version: 3.5.4
|
|
Summary: A python implementation of GNU readline.
|
|
Author-email: Bassem Girgis <brgirgis@gmail.com>, Jorgen Stenarson <jorgen.stenarson@kroywen.se>, Gary Bishop <unknwon@unknown.com>, Jack Trainor <unknwon@unknown.com>
|
|
Maintainer-email: Bassem Girgis <brgirgis@gmail.com>
|
|
License: BSD
|
|
Project-URL: Homepage, https://github.com/pyreadline3/pyreadline3
|
|
Project-URL: Documentation, https://github.com/pyreadline3/pyreadline3
|
|
Project-URL: Repository, https://github.com/pyreadline3/pyreadline3.git
|
|
Project-URL: Issues, https://github.com/pyreadline3/pyreadline3/issues
|
|
Project-URL: Changelog, https://github.com/pyreadline3/pyreadline3/blob/master/doc/ChangeLog
|
|
Keywords: readline,pyreadline,pyreadline3
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Console
|
|
Classifier: Operating System :: Microsoft :: Windows
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE.md
|
|
Provides-Extra: dev
|
|
Requires-Dist: build ; extra == 'dev'
|
|
Requires-Dist: flake8 ; extra == 'dev'
|
|
Requires-Dist: mypy ; extra == 'dev'
|
|
Requires-Dist: pytest ; extra == 'dev'
|
|
Requires-Dist: twine ; extra == 'dev'
|
|
|
|
# pyreadline3
|
|
|
|
[](https://pypi.org/project/pyreadline3/)
|
|
|
|
|
|
[](https://pepy.tech/project/pyreadline3)
|
|
[](https://pepy.tech/project/pyreadline3)
|
|
[](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
|