Repository files navigation

bpython is a lightweight Python interpreter that adds several features commonto IDEs. These features includesyntax highlighting,expected parameterlist,auto-indentation, andautocompletion. (See below for exampleusage).

bpython doesnot aim to be a complete IDE - the focus is on implementing afew ideas in a practical, useful, and lightweight manner.

bpython is a great replacement to any occasion where you would normally use thevanilla Python interpreter - testing out solutions to people's problems on IRC,quickly testing a method of doing something without creating a temporary file,etc.

You can find more about bpython - includingfull documentation - at ourhomepage.

If you havepip installed, you can simply run:

$ pip install bpython

Start bpython by typingbpython in your terminal. You can exit bpython byusing theexit() command or by pressing control-D like regular interactivePython.

• Readline-like autocomplete, with suggestions displayed as you type.
• In-line syntax highlighting. This uses Pygments for lexing the code as youtype, and colours appropriately.
• Expected parameter list. As in a lot of modern IDEs, bpython will attempt todisplay a list of parameters for any function you call. The inspect module (whichworks with any Python function) is tried first, and then pydoc if that fails.
• Rewind. This isn't called "Undo" because it would be misleading, but "Rewind"is probably as bad. The idea is that the code entered is kept in memory andwhen the Rewind function is called, the last line is popped and the entiresession is re-evaluated. Use <control-R> to rewind.
• Edit the current line or your entire session in an editor. F7 opens the currentsession in a text editor, and if modifications are made, the session is rerunwith these changes.
• Pastebin code/write to file. Use the <F8> key to upload the screen's contentsto pastebin, with a URL returned.
• Reload imported Python modules. Use <F6> to clear sys.modules and rerun yoursession to test changes to code in a module you're working on.

See the sample-config file for a list of available options. You should saveyour config file as~/.config/bpython/config (i.e.$XDG_CONFIG_HOME/bpython/config) or specify at the command line:

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

• 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 requires the following additional packages:

• urwid

The majority of desktop computer operating systems come with package managementsystems. If you use one of these OSes, you can installbpython using thepackage manager.

Ubuntu/Debian family Linux users can installbpython using theaptpackage manager, using the command withsudo privileges:

$ apt install bpython

In case you are using an older version, run

$ apt-get install bpython

Arch Linux usespacman as the default package manager; you can use it to installbpython:

$ pacman -S bpython

Fedora users can installbpython directly from the command line usingdnf.

$ dnf install bpython

Guix users can installbpython on any GNU/Linux distribution directly from the command line:

$ guix install bpython

macOS does not include a package manager by default. If you have installed anythird-party package manager like MacPorts, you can install it via

$ sudo port install py-bpython

For known bugs please see bpython'sknown issues and FAQ page.

I hope you find it useful and please feel free to submit any bugs/patchessuggestions toRobert or place them on the GitHubissues tracker.

For any other ways of communicating with bpython users and devs you can find usat the community page on theproject homepage, or in thecommunity.

Hope to see you there!