Skip to content

updating word for readme #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
carocancode wants to merge 2 commits into from
Closed

updating word for readme #999

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75b674e
Update README.rst
carocancode Jul 28, 2023
5215f69
Update README.rst
carocancode Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 33 additions & 30 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,20 @@
bpython: A fancy interface to the Python interactive interpreter
****************************************************************

`bpython`_ is a lightweight Python interpreter that adds several features common
to IDEs. These features include **syntax highlighting**, **expected parameter
list**, **auto-indentation**, and **autocompletion**. (See below for example
usage).
**Introduction:**
bpython is a lightweight Python interpreter with added features commonly found in integrated development environments (IDEs). These features include syntax highlighting, auto-indentation, autocompletion, and displaying expected parameter lists for functions.

**Features:**
- Autocomplete suggestions as you type (similar to Readline).
- In-line syntax highlighting using Pygments.
- Display of expected parameter lists for functions.
- Rewind function to re-evaluate and edit previous code.
- Open current session in an external text editor.
- Paste code to pastebin or write to a file.
- Reload imported Python modules to test changes.

**Usage:**
bpython is not a full IDE but a practical and lightweight solution. It's ideal for testing code, helping others on IRC, or quick experimentation.

.. image:: https://bpython-interpreter.org/images/math.gif
:alt: bpython
Expand All @@ -38,19 +48,22 @@ You can find more about bpython - including `full documentation`_ - at our
Installation & Basic Usage
==========================

Installation using Pip
----------------------

If you have `pip`_ installed, you can simply run:

.. code-block:: bash

$ pip install bpython

Start bpython by typing ``bpython`` in your terminal. You can exit bpython by
using the ``exit()`` command or by pressing control-D like regular interactive
Python.

**Installation:**
Using Pip:
If you have pip installed, run: `$ pip install bpython`
Start bpython by typing `bpython` in the terminal. Exit with `exit()` or `ctrl-D`.

**Dependencies:**
- Pygments
- curtsies >= 0.4.0
- greenlet
- pyxdg
- requests
- Sphinx >= 1.5 (optional, for documentation)
- babel (optional, for internationalization)
- jedi (optional, for multiline completion)
- watchdog (optional, for monitoring module changes)
- pyperclip (optional, for clipboard copying)
===================
Features & Examples
===================
Expand Down Expand Up @@ -78,6 +91,8 @@ Features & Examples
* Reload imported Python modules. Use <F6> to clear sys.modules and rerun your
session to test changes to code in a module you're working on.



=============
Configuration
=============
Expand All @@ -87,19 +102,7 @@ your config file as **~/.config/bpython/config** (i.e.

bpython --config /path/to/bpython/config

============
Dependencies
============
* Pygments
* curtsies >= 0.4.0
* greenlet
* pyxdg
* requests
* Sphinx >= 1.5 (optional, for the documentation)
* babel (optional, for internationalization)
* jedi (optional, for experimental multiline completion)
* watchdog (optional, for monitoring imported modules for changes)
* pyperclip (optional, for copying to the clipboard)


bpython-urwid
-------------
Expand Down