Skip to content

Commit cdfa6a2

Browse files
author
Deploy from CI
committed
Deploy 4408c52 to gh-pages
0 parents  commit cdfa6a2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1201
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write # To push a branch
12+
pull-requests: write # To create a PR from that branch
13+
steps:
14+
- uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
submodules: recursive
18+
- name: Install pelican
19+
run: |
20+
python3 -m venv venv
21+
./venv/bin/pip install -U pip
22+
./venv/bin/pip install pelican
23+
- name: Deploy GitHub Pages
24+
run: |
25+
# This assumes your book is in the root of your repository.
26+
# Just add a `cd` here if you need to change to another directory.
27+
./venv/bin/pelican
28+
git worktree add gh-pages
29+
git config user.name "Deploy from CI"
30+
git config user.email ""
31+
cd gh-pages
32+
# Delete the ref to avoid keeping history.
33+
git update-ref -d refs/heads/gh-pages
34+
rm -rf *
35+
mv ../output/* .
36+
echo 'bpython-interpreter.org' > CNAME
37+
git add .
38+
git commit -m "Deploy $GITHUB_SHA to gh-pages"
39+
git push --force --set-upstream origin gh-pages

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
cache/
2+
output/
3+
*.pyc
4+
venv

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "bsite-theme"]
2+
path = bsite-theme
3+
url = https://github.com/bpython/bsite-theme

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bpython-interpreter.org

about.html

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>About - bpython</title>
7+
8+
<link rel="stylesheet" href="./theme/css/main.css">
9+
<link rel="stylesheet" href="./theme/css/pygment_trac.css">
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<link rel="shortcut icon" href="./theme/images/favicon.png">
12+
</head>
13+
<body>
14+
<div class="wrapper">
15+
<header>
16+
<div><a href="./"><img src="./theme/images/bpython.png" class="logo-img"/></a></div>
17+
<div class="title"><a href="./">bpython </a></div>
18+
<div class="sub-title"></div>
19+
<p>
20+
<div class="view"><a href="./">Home</a></div>
21+
<div class="view"><a href="./downloads.html">Downloads</a></div>
22+
<div class="view"><a href="./screenshots.html">Screenshots</a></div>
23+
<div class="view"><a href="./about.html">About</a></div>
24+
<div class="view"><a href="./alternatives.html">Alternatives</a></div>
25+
<div class="view"><a href="./community.html">Community</a></div>
26+
<div class="view"><a href="./known-issues-and-faq.html">Known issues and FAQ</a></div>
27+
<div class="view"><a href="./donate.html">Donate?</a></div>
28+
</p>
29+
30+
<p>
31+
<div class="view"><em><a href="http://docs.bpython-interpreter.org">documentation</a></em></div>
32+
<div class="view"><em><a href="http://bpaste.net">bpaste</a></em></div>
33+
</p> </header>
34+
<section>
35+
<section id="content" class="body">
36+
<h1 class="entry-title">About</h1>
37+
38+
<div class="section" id="introduction">
39+
<h2>Introduction</h2>
40+
<p>A few people asked for stuff like syntax highlighting and autocomplete for the Python interactive interpreter. IPython seems to offer this (plus you can get readline behaviour in the vanilla interpreter) but I tried IPython a couple of times. Perhaps I didn't really get it, but I get the feeling that the ideas behind IPython are pretty different to bpython. I didn't want to create a whole development environment; I simply wanted to provide a couple of neat features that already exist and turn them into something a little more interactive.</p>
41+
<p>The idea is to provide the user with all the features in-line, much like modern IDEs, but in a simple, lightweight package that can be run in a terminal window, so curses seemed like the best choice. Sorry if you use Windows.</p>
42+
<p>bpython doesn't attempt to create anything new or groundbreaking, it simply brings together a few neat ideas and focuses on practicality and usefulness. For this reason, the &quot;Rewind&quot; function should be taken with a pinch of salt, but personally I have found it to be very useful. I use bpython now whenever I would normally use the vanilla interpreter, e.g. for testing out solutions to people's problems on IRC, quickly testing a method of doing something without creating a temporary file, etc..</p>
43+
<p>I hope you find it useful and please feel free to submit any bugs/patches (yeah right)/suggestions to the <a class="reference external" href="/community.html">mailing list</a>. Money is also accepted.</p>
44+
</div>
45+
<div class="section" id="features">
46+
<h2>Features</h2>
47+
<div class="section" id="in-line-syntax-highlighting">
48+
<h3>In-line syntax highlighting.</h3>
49+
<p>This uses Pygments for lexing the code as you type, and colours appropriately. Pygments does a great job of doing all of the tricky stuff and really leaving me with very little to do except format the tokens in all my favourite colours.</p>
50+
</div>
51+
<div class="section" id="readline-like-autocomplete-with-suggestions-displayed-as-you-type">
52+
<h3>Readline-like autocomplete with suggestions displayed as you type.</h3>
53+
<p>Thanks to Python's readline interface to libreadline and a ready-made class for using a Python interpreter's scope as the dataset, the only work here was displaying the readline matches as you type in a separate curses window below/above the cursor.</p>
54+
</div>
55+
<div class="section" id="expected-parameter-list">
56+
<h3>Expected parameter list.</h3>
57+
<p>As in a lot of modern IDEs, bpython will attempt to display a list of parameters for any function you call. The inspect module is tried first, which works with any Python function, and then pydoc if that fails, which seems to be pretty adequate, but obviously in some cases it's simply not possible. I used pyparsing to cure my nested parentheses woes; again, it was nice and easy.</p>
58+
</div>
59+
<div class="section" id="rewind">
60+
<h3>Rewind.</h3>
61+
<p>I didn't call this &quot;Undo&quot; because I thought that would be misleading, but &quot;Rewind&quot; is probably as bad. The idea is that the code entered is kept in memory and when the Rewind function is called, the last line is popped and the entire code is re-evaluated. As you can imagine, this has a lot of potential problems, but for defining classes and functions, I've found it to be nothing but useful.</p>
62+
</div>
63+
<div class="section" id="pastebin-code-write-to-file">
64+
<h3>Pastebin code/write to file.</h3>
65+
<p>I don't really use the save thing much, but the pastebin thing's great. Hit a key and what you see on the screen will be sent to a pastebin and a URL is returned for you to do what you like with. bpaste.net is used by default, but you can configure bpython to use a different pastebin.</p>
66+
</div>
67+
<div class="section" id="flush-curses-screen-to-stdout">
68+
<h3>Flush curses screen to stdout.</h3>
69+
<p>A featurette, perhaps, but I thought it was worth noting. I can't personally recall a curses app that does this, perhaps it's often not useful, but when you quit bpython, the screen data will be flushed to stdout, so it basically looks the same as if you had quit the vanilla interpreter.</p>
70+
</div>
71+
<div class="section" id="python-3-support">
72+
<h3>Python 3 support</h3>
73+
<p>bpython supports Python 3. It's as simple as running setup.py with Python 3.</p>
74+
</div>
75+
<div class="section" id="configuration">
76+
<h3>Configuration</h3>
77+
<p>See the sample-config file for a list of available options. You should save your
78+
ini file as <tt class="docutils literal">$XDG_CONFIG_HOME/bpython/config</tt> <a class="footnote-reference" href="#f1" id="footnote-reference-1">[1]</a> or specify at the command
79+
line:</p>
80+
<div class="highlight"><pre><span></span>bpython<span class="w"> </span>--config<span class="o">=</span>/path/to/a/bpython/config/file
81+
</pre></div>
82+
</div>
83+
<div class="section" id="artwork">
84+
<h3>Artwork</h3>
85+
<p>Our logo and colors have been masterfully created by Leo Hutson.</p>
86+
<!-- :: Footnotes -->
87+
<table class="docutils footnote" frame="void" id="f1" rules="none">
88+
<colgroup><col class="label" /><col /></colgroup>
89+
<tbody valign="top">
90+
<tr><td class="label"><a class="fn-backref" href="#footnote-reference-1">[1]</a></td><td><tt class="docutils literal">$XDG_CONFIG_HOME</tt> defaults to <tt class="docutils literal"><span class="pre">~/.config</span></tt> if not set.</td></tr>
91+
</tbody>
92+
</table>
93+
</div>
94+
</div>
95+
96+
</section>
97+
</section>
98+
<footer>
99+
<p><small>&copy; bpython &mdash; Theme based on Sundown by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
100+
</footer>
101+
</div>
102+
</body>
103+
</html>

alternatives.html

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Alternatives - bpython</title>
7+
8+
<link rel="stylesheet" href="./theme/css/main.css">
9+
<link rel="stylesheet" href="./theme/css/pygment_trac.css">
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<link rel="shortcut icon" href="./theme/images/favicon.png">
12+
</head>
13+
<body>
14+
<div class="wrapper">
15+
<header>
16+
<div><a href="./"><img src="./theme/images/bpython.png" class="logo-img"/></a></div>
17+
<div class="title"><a href="./">bpython </a></div>
18+
<div class="sub-title"></div>
19+
<p>
20+
<div class="view"><a href="./">Home</a></div>
21+
<div class="view"><a href="./downloads.html">Downloads</a></div>
22+
<div class="view"><a href="./screenshots.html">Screenshots</a></div>
23+
<div class="view"><a href="./about.html">About</a></div>
24+
<div class="view"><a href="./alternatives.html">Alternatives</a></div>
25+
<div class="view"><a href="./community.html">Community</a></div>
26+
<div class="view"><a href="./known-issues-and-faq.html">Known issues and FAQ</a></div>
27+
<div class="view"><a href="./donate.html">Donate?</a></div>
28+
</p>
29+
30+
<p>
31+
<div class="view"><em><a href="http://docs.bpython-interpreter.org">documentation</a></em></div>
32+
<div class="view"><em><a href="http://bpaste.net">bpaste</a></em></div>
33+
</p> </header>
34+
<section>
35+
<section id="content" class="body">
36+
<h1 class="entry-title">Alternatives</h1>
37+
38+
<p>bpython isn't the only alternative Python shell. Each project has its own goals and values, so you may find bpython isn't the right tool for your needs. We know for sure that some people prefer IPython to bpython, so we think it's a good idea to make sure you're aware of other tools available.</p>
39+
<p>If you know of any others please let us know. And if you're the author of any of the listed projects and would like to add a brief description to the page feel free to get in touch.</p>
40+
<blockquote>
41+
<ul class="simple">
42+
<li><a class="reference external" href="https://github.com/noamraph/dreampie">DreamPie</a></li>
43+
<li><a class="reference external" href="http://ipython.org">IPython</a></li>
44+
<li><a class="reference external" href="https://github.com/jonathanslenders/ptpython">ptpython</a></li>
45+
<li><a class="reference external" href="https://docs.python.org/3/library/idle.html">IDLE</a></li>
46+
</ul>
47+
</blockquote>
48+
49+
</section>
50+
</section>
51+
<footer>
52+
<p><small>&copy; bpython &mdash; Theme based on Sundown by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
53+
</footer>
54+
</div>
55+
</body>
56+
</html>

archives.html

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title> - bpython</title>
7+
8+
<link rel="stylesheet" href="./theme/css/main.css">
9+
<link rel="stylesheet" href="./theme/css/pygment_trac.css">
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<link rel="shortcut icon" href="./theme/images/favicon.png">
12+
</head>
13+
<body>
14+
<div class="wrapper">
15+
<header>
16+
<div><a href="./"><img src="./theme/images/bpython.png" class="logo-img"/></a></div>
17+
<div class="title"><a href="./">bpython </a></div>
18+
<div class="sub-title"></div>
19+
<p>
20+
<div class="view"><a href="./">Home</a></div>
21+
<div class="view"><a href="./downloads.html">Downloads</a></div>
22+
<div class="view"><a href="./screenshots.html">Screenshots</a></div>
23+
<div class="view"><a href="./about.html">About</a></div>
24+
<div class="view"><a href="./alternatives.html">Alternatives</a></div>
25+
<div class="view"><a href="./community.html">Community</a></div>
26+
<div class="view"><a href="./known-issues-and-faq.html">Known issues and FAQ</a></div>
27+
<div class="view"><a href="./donate.html">Donate?</a></div>
28+
</p>
29+
30+
<p>
31+
<div class="view"><em><a href="http://docs.bpython-interpreter.org">documentation</a></em></div>
32+
<div class="view"><em><a href="http://bpaste.net">bpaste</a></em></div>
33+
</p> </header>
34+
<section>
35+
<section id="content" class="body">
36+
<h1>Archives for bpython</h1>
37+
38+
<dl>
39+
</dl>
40+
</section>
41+
</section>
42+
<footer>
43+
<p><small>&copy; bpython &mdash; Theme based on Sundown by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
44+
</footer>
45+
</div>
46+
</body>
47+
</html>

authors.html

Whitespace-only changes.

categories.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>bpython - Categories - bpython</title>
7+
8+
<link rel="stylesheet" href="./theme/css/main.css">
9+
<link rel="stylesheet" href="./theme/css/pygment_trac.css">
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<link rel="shortcut icon" href="./theme/images/favicon.png">
12+
</head>
13+
<body>
14+
<div class="wrapper">
15+
<header>
16+
<div><a href="./"><img src="./theme/images/bpython.png" class="logo-img"/></a></div>
17+
<div class="title"><a href="./">bpython </a></div>
18+
<div class="sub-title"></div>
19+
<p>
20+
<div class="view"><a href="./">Home</a></div>
21+
<div class="view"><a href="./downloads.html">Downloads</a></div>
22+
<div class="view"><a href="./screenshots.html">Screenshots</a></div>
23+
<div class="view"><a href="./about.html">About</a></div>
24+
<div class="view"><a href="./alternatives.html">Alternatives</a></div>
25+
<div class="view"><a href="./community.html">Community</a></div>
26+
<div class="view"><a href="./known-issues-and-faq.html">Known issues and FAQ</a></div>
27+
<div class="view"><a href="./donate.html">Donate?</a></div>
28+
</p>
29+
30+
<p>
31+
<div class="view"><em><a href="http://docs.bpython-interpreter.org">documentation</a></em></div>
32+
<div class="view"><em><a href="http://bpaste.net">bpaste</a></em></div>
33+
</p> </header>
34+
<section>
35+
<h2>Categories on bpython</h2>
36+
<ul>
37+
</ul>
38+
</section>
39+
<footer>
40+
<p><small>&copy; bpython &mdash; Theme based on Sundown by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
41+
</footer>
42+
</div>
43+
</body>
44+
</html>

community.html

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<title>Community - bpython</title>
7+
8+
<link rel="stylesheet" href="./theme/css/main.css">
9+
<link rel="stylesheet" href="./theme/css/pygment_trac.css">
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<link rel="shortcut icon" href="./theme/images/favicon.png">
12+
</head>
13+
<body>
14+
<div class="wrapper">
15+
<header>
16+
<div><a href="./"><img src="./theme/images/bpython.png" class="logo-img"/></a></div>
17+
<div class="title"><a href="./">bpython </a></div>
18+
<div class="sub-title"></div>
19+
<p>
20+
<div class="view"><a href="./">Home</a></div>
21+
<div class="view"><a href="./downloads.html">Downloads</a></div>
22+
<div class="view"><a href="./screenshots.html">Screenshots</a></div>
23+
<div class="view"><a href="./about.html">About</a></div>
24+
<div class="view"><a href="./alternatives.html">Alternatives</a></div>
25+
<div class="view"><a href="./community.html">Community</a></div>
26+
<div class="view"><a href="./known-issues-and-faq.html">Known issues and FAQ</a></div>
27+
<div class="view"><a href="./donate.html">Donate?</a></div>
28+
</p>
29+
30+
<p>
31+
<div class="view"><em><a href="http://docs.bpython-interpreter.org">documentation</a></em></div>
32+
<div class="view"><em><a href="http://bpaste.net">bpaste</a></em></div>
33+
</p> </header>
34+
<section>
35+
<section id="content" class="body">
36+
<h1 class="entry-title">Community</h1>
37+
38+
<p>bpython has a small and friendly community surrounding it! Read this page to
39+
know how to find us.</p>
40+
<div class="section" id="issue-tracker">
41+
<h2>Issue Tracker</h2>
42+
<p>If you find a bug in bpython or have a suggestion for a new feature, please
43+
make sure you're using the latest development release (see <a class="reference external" href="/downloads.html">download</a> page)
44+
and if it hasn't been fixed/added, go <a class="reference external" href="https://github.com/bpython/bpython/issues">here</a> and open a new issue.</p>
45+
</div>
46+
<div class="section" id="irc">
47+
<h2>IRC</h2>
48+
<p>Join us in #bpython on irc.freenode.net.</p>
49+
</div>
50+
<div class="section" id="mailing-list">
51+
<h2>Mailing List</h2>
52+
<p>You can ask a question at our <a class="reference external" href="https://groups.google.com/forum/#!forum/bpython">mailing list</a> if you prefer.</p>
53+
</div>
54+
<div class="section" id="twitter">
55+
<h2>Twitter</h2>
56+
<p>bpython has its own account: <a class="reference external" href="http://twitter.com/bpythonrepl">bpythonrepl</a>. You can also follow Bob at
57+
<a class="reference external" href="http://twitter.com/bob_farrell">bob_farrell</a> or you can follow <a class="reference external" href="http://twitter.com/supakeen">supakeen</a> for bpython news.</p>
58+
</div>
59+
<div class="section" id="email">
60+
<h2>Email</h2>
61+
<p>If you have issues that prevent you from using IRC or signing up to a mailing
62+
list you can email Bob:</p>
63+
<p><cite>bob at bpython-interpreter dot org</cite></p>
64+
<p>(That's <a class="reference external" href="mailto:bob&#64;bpython-interpreter.org">bob&#64;bpython-interpreter.org</a>, except it stops spam bots from finding
65+
Bob's address).</p>
66+
</div>
67+
68+
</section>
69+
</section>
70+
<footer>
71+
<p><small>&copy; bpython &mdash; Theme based on Sundown by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
72+
</footer>
73+
</div>
74+
</body>
75+
</html>

0 commit comments

Comments
 (0)