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
|
.. _contributing:
Contributing to bpython
=======================
Thanks for working on bpython!
On the `GitHub issue tracker`_ some issues are labeled bite-size_ -
these are particularly good ones to start out with.
See our section about the :ref:`community` for a list of resources.
`#bpython <irc://irc.oftc.net/bpython>`_ on OFTC is particularly useful,
but you might have to wait for a while to get a question answered depending on
the time of day.
Getting your development environment set up
-------------------------------------------
bpython supports Python 3.9 and newer. The code is compatible with all
supported versions.
Using a virtual environment is probably a good idea. Create a virtual
environment with
.. code-block:: bash
# determines Python version used
$ virtualenv bpython-dev
# necessary every time you work on bpython
$ source bpython-dev/bin/activate
Fork bpython in the GitHub web interface. Be sure to include the tags
in your fork by un-selecting the option to copy only the main branch.
Then, clone the forked repo:
.. code-block:: bash
$ git clone git@github.com:YOUR_GITHUB_USERNAME/bpython.git
# or "git clone https://github.com/YOUR_GITHUB_USERNAME/bpython.git"
Next install your development copy of bpython and its dependencies:
.. code-block:: bash
$ cd bpython
# install bpython and required dependencies
$ pip install -e .
# install optional dependencies
$ pip install watchdog urwid
# development dependencies
$ pip install sphinx pytest
<modify a file in some way>
# this runs your modified copy of bpython!
$ bpython
.. note::
Many requirements are also available from your distribution's package
manager. On Debian/Ubuntu based systems, the following packages can be
used:
.. code-block:: bash
$ sudo apt install python3-greenlet python3-pygments python3-requests
$ sudo apt install python3-watchdog python3-urwid
$ sudo apt install python3-sphinx python3-pytest
You also need to run `virtualenv` with `--system-site-packages` packages, if
you want to use the packages provided by your distribution.
.. note::
Installation of some dependencies with ``pip`` requires Python headers and
a C compiler. These are also available from your package manager.
.. code-block:: bash
$ sudo apt install gcc python3-dev
As a first dev task, I recommend getting `bpython` to print your name every
time you hit a specific key.
To run tests from the bpython directory:
.. code-block:: bash
$ pytest
Building the documentation
--------------------------
The documentation is included in the bpython repository. After
checking out the bpython repository and installing `sphinx` as described in
the previous step, you can run the following command in your checkout of the
repository to build the documentation:
.. code-block:: bash
$ make -C doc/sphinx html
Afterwards you can point your browser to `doc/sphinx/build/html/index.html`.
Don't forget to recreate the HTML after you make changes.
Hacking on the site or theme
----------------------------
The site (and its theme as well) is stored in a separate repository and built
using pelican. To start hacking on the site you need to start out with a
checkout and probably a virtual environment:
.. code-block:: bash
$ virtualenv bpython-site-dev
$ source bpython-site-dev/bin/activate
$ pip install pelican
Fork bsite and bsite-theme in the GitHub web interface, then clone the
repositories:
.. code-block:: bash
$ git clone git@github.com:YOUR_GITHUB_USERNAME/bsite.git
$ git clone git@github.com:YOUR_GITHUB_USERNAME/bsite-theme.git
Next you can fiddle around in the source files. If you want to build the site
you activate your virtualenv and tell pelican to generate the site with the
included configuration file.
.. code-block:: bash
$ source bpython-site-dev/bin/activate
# if you want to fiddle on the text of the site otherwise go into
# bsite-theme
$ cd bsite
# if you checked out the theme in a different place, use that path
$ pelican -t ../bsite-theme -s pelicanconf.py
After this you can open the `output/index.html` in your favourite browser and
see if your changes had an effect.
.. _GitHub issue tracker: https://github.com/bpython/bpython/issues
.. _bite-size: https://github.com/bpython/bpython/labels/bitesize
|
