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
|
Development
===========
.. highlight:: bash
If you wish to contribute to this project, then you should fork the
repository found here:
https://github.com/python-excel/xlrd
Once that has been done and you have a checkout, you can follow these
instructions to perform various development tasks:
Setting up a virtualenv
-----------------------
The recommended way to set up a development environment is to turn
your checkout into a virtualenv and then install the package in
editable form as follows::
$ virtualenv .
$ bin/pip install -e .[test]
Running the tests
-----------------
Once you've set up a virtualenv, the tests can be run as follows::
$ source bin/activate
$ pytest
Building the documentation
--------------------------
The Sphinx documentation is built by doing the following, having activated
the virtualenv above, from the directory containing setup.py::
$ source bin/activate
$ cd docs
$ make html
To check that the description that will be used on PyPI renders properly,
do the following::
$ python setup.py --long-description | rst2html.py > desc.html
Making a release
----------------
To make a release, just update the version in ``xlrd.info.__VERSION__``, update the change log
and push to https://github.com/python-excel/xlrd
and Carthorse should take care of the rest.
|
