Skip to content

Commit 8411460

Browse files
supakeencoder0
supakeen
authored and
coder0
committed
Re-order installation, usage, and OS installation.
- Removal of the Windows subsection (these will move to docs). - Rename of "Mac OS" to "macOS". - Remove 'curses' from the title. - Remove 'alternatives' section.
1 parent 30545ef commit 8411460

File tree

1 file changed

+52
-113
lines changed

1 file changed

+52
-113
lines changed

‎README.rst‎

Lines changed: 52 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
:target: https://github.com/ambv/black
99

1010

11-
***********************************************************************
12-
bpython: A fancy curses interface to the Python interactive interpreter
13-
***********************************************************************
11+
****************************************************************
12+
bpython: A fancy interface to the Python interactive interpreter
13+
****************************************************************
1414

1515
`bpython`_ is a lightweight Python interpreter that adds several features common
1616
to IDEs. These features include **syntax highlighting**, **expected parameter
@@ -51,71 +51,6 @@ Start bpython by typing ``bpython`` in your terminal. You can exit bpython by
5151
using the ``exit()`` command or by pressing control-D like regular interactive
5252
Python.
5353

54-
Installation via OS Package Manager
55-
-----------------------------------
56-
57-
The majority of desktop computer operating systems come with package management
58-
systems. If you use one of these OSes, you can install ``bpython`` using the
59-
package manager.
60-
61-
Ubuntu/Debian
62-
~~~~~~~~~~~~~
63-
Ubuntu/Debian family Linux users can install ``bpython`` using the ``apt``
64-
package manager, using the command with ``sudo`` privileges:
65-
66-
.. code-block:: bash
67-
68-
$ apt install bpython
69-
70-
In case you are using an older version, run
71-
72-
.. code-block:: bash
73-
74-
$ apt-get install bpython
75-
76-
Arch Linux
77-
~~~~~~~~~~
78-
Arch Linux uses ``pacman`` as the default package manager; you can use it to install ``bpython``:
79-
80-
.. code-block:: bash
81-
82-
$ pacman -S bpython
83-
84-
Fedora
85-
~~~~~~~~~~
86-
Fedora users can install ``bpython`` directly from the command line using ``dnf``.
87-
88-
.. code-block:: bash
89-
90-
$ dnf install bpython
91-
92-
Windows
93-
~~~~~~~
94-
**Caveats:** As ``bpython`` makes use of the ncurses library of \*nix-family operating systems,
95-
bpython on Windows is not officially supported and tested.
96-
97-
However, you may still use bpython on Windows using a workaround. In brief, you should install
98-
these two packages using ``pip``:
99-
100-
.. code-block:: bash
101-
102-
$ pip install bpython windows-curses
103-
104-
Then you should invoke a program called ``bpython-curses.exe`` instead of ``bpython.exe`` to use bpython:
105-
106-
.. code-block:: bash
107-
108-
$ bpython-curses
109-
110-
Mac OS
111-
~~~~~~
112-
Like Windows, Mac OS does not include a package manager by default. If you have installed any
113-
third-party package manager like MacPorts, you can install it via
114-
115-
.. code-block:: bash
116-
117-
$ sudo port install py-bpython
118-
11954
===================
12055
Features & Examples
12156
===================
@@ -172,69 +107,73 @@ bpython-urwid
172107

173108
* urwid
174109

175-
==========
176-
Known Bugs
177-
==========
178-
For known bugs please see bpython's `known issues and FAQ`_ page.
179110

180-
======================
181-
Contact & Contributing
182-
======================
183-
I hope you find it useful and please feel free to submit any bugs/patches
184-
suggestions to `Robert`_ or place them on the GitHub
185-
`issues tracker`_.
111+
===================================
112+
Installation via OS Package Manager
113+
===================================
186114

187-
For any other ways of communicating with bpython users and devs you can find us
188-
at the community page on the `project homepage`_, or in the `community`_.
115+
The majority of desktop computer operating systems come with package management
116+
systems. If you use one of these OSes, you can install ``bpython`` using the
117+
package manager.
189118

190-
Hope to see you there!
119+
Ubuntu/Debian
120+
~~~~~~~~~~~~~
121+
Ubuntu/Debian family Linux users can install ``bpython`` using the ``apt``
122+
package manager, using the command with ``sudo`` privileges:
191123

192-
===================
193-
CLI Windows Support
194-
===================
124+
.. code-block:: bash
195125
196-
Dependencies
197-
------------
198-
`Curses`_ Use the appropriate version compiled by Christoph Gohlke.
126+
$ apt install bpython
199127
200-
`pyreadline`_ Use the version in the cheeseshop.
128+
In case you are using an older version, run
201129

202-
Recommended
203-
-----------
204-
Obtain the less program from GnuUtils. This makes the pager work as intended.
205-
It can be obtained from cygwin or GnuWin32 or msys
130+
.. code-block:: bash
206131
207-
Current version is tested with
208-
------------------------------
209-
* Curses 2.2
210-
* pyreadline 1.7
132+
$ apt-get install bpython
211133
212-
Curses Notes
213-
------------
214-
The curses used has a bug where the colours are displayed incorrectly:
134+
Arch Linux
135+
~~~~~~~~~~
136+
Arch Linux uses ``pacman`` as the default package manager; you can use it to install ``bpython``:
215137

216-
* red is swapped with blue
217-
* cyan is swapped with yellow
138+
.. code-block:: bash
218139
219-
To correct this I have provided a windows.theme file.
140+
$ pacman -S bpython
220141
221-
This curses implementation has 16 colors (dark and light versions of the
222-
colours)
142+
Fedora
143+
~~~~~~~~~~
144+
Fedora users can install ``bpython`` directly from the command line using ``dnf``.
223145

146+
.. code-block:: bash
147+
148+
$ dnf install bpython
149+
150+
macOS
151+
~~~~~
152+
macOS does not include a package manager by default. If you have installed any
153+
third-party package manager like MacPorts, you can install it via
154+
155+
.. code-block:: bash
156+
157+
$ sudo port install py-bpython
224158
225-
============
226-
Alternatives
227-
============
228159
229-
`ptpython`_
160+
==========
161+
Known Bugs
162+
==========
163+
For known bugs please see bpython's `known issues and FAQ`_ page.
164+
165+
======================
166+
Contact & Contributing
167+
======================
168+
I hope you find it useful and please feel free to submit any bugs/patches
169+
suggestions to `Robert`_ or place them on the GitHub
170+
`issues tracker`_.
230171

231-
`IPython`_
172+
For any other ways of communicating with bpython users and devs you can find us
173+
at the community page on the `project homepage`_, or in the `community`_.
232174

233-
Feel free to get in touch if you know of any other alternatives that people
234-
may be interested to try.
175+
Hope to see you there!
235176

236-
.. _ptpython: https://github.com/jonathanslenders/ptpython
237-
.. _ipython: https://ipython.org/
238177
.. _homepage: http://www.bpython-interpreter.org
239178
.. _full documentation: http://docs.bpython-interpreter.org/
240179
.. _issues tracker: http://github.com/bpython/bpython/issues/

0 commit comments

Comments
 (0)