development.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. Development
  2. ===========
  3. .. highlight:: bash
  4. This package is developed using continuous integration which can be
  5. found here:
  6. https://travis-ci.org/python-excel/xlwt
  7. If you wish to contribute to this project, then you should fork the
  8. repository found here:
  9. https://github.com/python-excel/xlwt
  10. Once that has been done and you have a checkout, you can follow these
  11. instructions to perform various development tasks:
  12. Setting up a virtualenv
  13. -----------------------
  14. The recommended way to set up a development environment is to turn
  15. your checkout into a virtualenv and then install the package in
  16. editable form as follows::
  17. $ virtualenv .
  18. $ bin/pip install -Ur requirements.txt
  19. $ bin/pip install -e .
  20. Running the tests
  21. -----------------
  22. Once you've set up a virtualenv, the tests can be run as follows::
  23. $ bin/nosetests
  24. To run tests on all the versions of Python that are supported, you can do::
  25. $ bin/tox
  26. If you change the supported python versions in ``.travis.yml``, please remember
  27. to do the following to update ``tox.ini``::
  28. $ bin/panci --to=tox .travis.yml > tox.ini
  29. Building the documentation
  30. --------------------------
  31. The Sphinx documentation is built by doing the following, having activated
  32. the virtualenv above, from the directory containing setup.py::
  33. $ cd docs
  34. $ make html
  35. Making a release
  36. ----------------
  37. To make a release, just update the version in ``xlwt/__init__.py``,
  38. update the change log, tag it
  39. and push to https://github.com/python-excel/xlwt
  40. and Travis CI should take care of the rest.
  41. Once the above is done, make sure to go to
  42. https://readthedocs.org/projects/xlwt/versions/
  43. and make sure the new release is marked as an Active Version.