summaryrefslogtreecommitdiffstats
path: root/ptpython.egg-info/PKG-INFO
blob: 9446457254d5749e23e11bf3d6356fb216961305 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
Metadata-Version: 2.1
Name: ptpython
Version: 3.0.20
Summary: Python REPL build on top of prompt_toolkit
Home-page: https://github.com/prompt-toolkit/ptpython
Author: Jonathan Slenders
License: UNKNOWN
Description: ptpython
        ========
        
        |Build Status|  |PyPI|  |License|
        
        *A better Python REPL*
        
        ::
        
            pip install ptpython
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/example1.png
        
        Ptpython is an advanced Python REPL. It should work on all
        Python versions from 2.6 up to 3.9 and work cross platform (Linux,
        BSD, OS X and Windows).
        
        Note: this version of ptpython requires at least Python 3.6. Install ptpython
        2.0.5 for older Python versions.
        
        
        Installation
        ************
        
        Install it using pip:
        
        ::
        
            pip install ptpython
        
        Start it by typing ``ptpython``.
        
        
        Features
        ********
        
        - Syntax highlighting.
        - Multiline editing (the up arrow works).
        - Autocompletion.
        - Mouse support. [1]
        - Support for color schemes.
        - Support for `bracketed paste <https://cirw.in/blog/bracketed-paste>`_ [2].
        - Both Vi and Emacs key bindings.
        - Support for double width (Chinese) characters.
        - ... and many other things.
        
        
        [1] Disabled by default. (Enable in the menu.)
        
        [2] If the terminal supports it (most terminals do), this allows pasting
        without going into paste mode. It will keep the indentation.
        
        __pt_repr__: A nicer repr with colors
        *************************************
        
        When classes implement a ``__pt_repr__`` method, this will be used instead of
        ``__repr__`` for printing. Any `prompt_toolkit "formatted text"
        <https://python-prompt-toolkit.readthedocs.io/en/master/pages/printing_text.html>`_
        can be returned from here. In order to avoid writing a ``__repr__`` as well,
        the ``ptpython.utils.ptrepr_to_repr`` decorator can be applied. For instance:
        
        .. code:: python
        
            from ptpython.utils import ptrepr_to_repr
            from prompt_toolkit.formatted_text import HTML
        
            @ptrepr_to_repr
            class MyClass:
                def __pt_repr__(self):
                    return HTML('<yellow>Hello world!</yellow>')
        
        More screenshots
        ****************
        
        The configuration menu:
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ptpython-menu.png
        
        The history page and its help:
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ptpython-history-help.png
        
        Autocompletion:
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/file-completion.png
        
        
        Embedding the REPL
        ******************
        
        Embedding the REPL in any Python application is easy:
        
        .. code:: python
        
            from ptpython.repl import embed
            embed(globals(), locals())
        
        You can make ptpython your default Python REPL by creating a `PYTHONSTARTUP file
        <https://docs.python.org/3/tutorial/appendix.html#the-interactive-startup-file>`_ containing code
        like this:
        
        .. code:: python
        
           import sys
           try:
               from ptpython.repl import embed
           except ImportError:
               print("ptpython is not available: falling back to standard prompt")
           else:
               sys.exit(embed(globals(), locals()))
        
        
        Multiline editing
        *****************
        
        Multi-line editing mode will automatically turn on when you press enter after a
        colon.
        
        To execute the input in multi-line mode, you can either press ``Alt+Enter``, or
        ``Esc`` followed by ``Enter``. (If you want the first to work in the OS X
        terminal, you have to check the "Use option as meta key" checkbox in your
        terminal settings. For iTerm2, you have to check "Left option acts as +Esc" in
        the options.)
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/multiline.png
        
        
        Syntax validation
        *****************
        
        Before execution, ``ptpython`` will see whether the input is syntactically
        correct Python code. If not, it will show a warning, and move the cursor to the
        error.
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/validation.png
        
        
        Additional features
        *******************
        
        Running system commands: Press ``Meta-!`` in Emacs mode or just ``!`` in Vi
        navigation mode to see the "Shell command" prompt. There you can enter system
        commands without leaving the REPL.
        
        Selecting text: Press ``Control+Space`` in Emacs mode or ``V`` (major V) in Vi
        navigation mode.
        
        
        Configuration
        *************
        
        It is possible to create a ``config.py`` file to customize configuration.
        ptpython will look in an appropriate platform-specific directory via `appdirs
        <https://pypi.org/project/appdirs/>`. See the ``appdirs`` documentation for the
        precise location for your platform. A ``PTPYTHON_CONFIG_HOME`` environment
        variable, if set, can also be used to explicitly override where configuration
        is looked for.
        
        Have a look at this example to see what is possible:
        `config.py <https://github.com/jonathanslenders/ptpython/blob/master/examples/ptpython_config/config.py>`_
        
        
        IPython support
        ***************
        
        Run ``ptipython`` (prompt_toolkit - IPython), to get a nice interactive shell
        with all the power that IPython has to offer, like magic functions and shell
        integration. Make sure that IPython has been installed. (``pip install
        ipython``)
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ipython.png
        
        This is also available for embedding:
        
        .. code:: python
        
            from ptpython.ipython.repl import embed
            embed(globals(), locals())
        
        
        Django support
        **************
        
        `django-extensions <https://github.com/django-extensions/django-extensions>`_
        has a ``shell_plus`` management command. When ``ptpython`` has been installed,
        it will by default use ``ptpython`` or ``ptipython``.
        
        
        PDB
        ***
        
        There is an experimental PDB replacement: `ptpdb
        <https://github.com/jonathanslenders/ptpdb>`_.
        
        
        Windows support
        ***************
        
        ``prompt_toolkit`` and ``ptpython`` works better on Linux and OS X than on
        Windows. Some things might not work, but it is usable:
        
        .. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/windows.png
        
        
        FAQ
        ***
        
        **Q**: The ``Ctrl-S`` forward search doesn't work and freezes my terminal.
        
        **A**: Try to run ``stty -ixon`` in your terminal to disable flow control.
        
        **Q**: The ``Meta``-key doesn't work.
        
        **A**: For some terminals you have to enable the Alt-key to act as meta key, but you 
        can also type ``Escape`` before any key instead.
        
        
        Alternatives
        ************
        
        - `BPython <http://bpython-interpreter.org/downloads.html>`_
        - `IPython <https://ipython.org/>`_
        
        If you find another alternative, you can create an issue and we'll list it
        here. If you find a nice feature somewhere that is missing in ``ptpython``,
        also create a GitHub issue and maybe we'll implement it.
        
        
        Special thanks to
        *****************
        
        - `Pygments <http://pygments.org/>`_: Syntax highlighter.
        - `Jedi <http://jedi.jedidjah.ch/en/latest/>`_: Autocompletion library.
        - `wcwidth <https://github.com/jquast/wcwidth>`_: Determine columns needed for a wide characters.
        - `prompt_toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>`_ for the interface.
        
        .. |Build Status| image:: https://api.travis-ci.org/prompt-toolkit/ptpython.svg?branch=master
            :target: https://travis-ci.org/prompt-toolkit/ptpython#
        
        .. |License| image:: https://img.shields.io/github/license/prompt-toolkit/ptpython.svg
            :target: https://github.com/prompt-toolkit/ptpython/blob/master/LICENSE
        
        .. |PyPI| image:: https://pypip.in/version/ptpython/badge.svg
            :target: https://pypi.python.org/pypi/ptpython/
            :alt: Latest Version
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python
Requires-Python: >=3.6
Provides-Extra: ptipython
Provides-Extra: all