The program is currently developed on Linux (openSuse). I have only little knowledge of Windows and Mac OS, therefore developers from these platforms are very welcome!
The IDE Eclipse with its extension Pydev is used for coding, and debugging. The version control system Bazaar maintains the source code’s history. Launchpad is used for code hosting and to organize the project. The development website is here:
To get all development files type:
bzr branch lp:jbidwatcher-companion
Testing is done with the py.test framework. All tests are in the file test_ebstat.py. To run the tests: change to the src/ directory and type:
py.test
The test framework will then (find and) run the tests. In case of any errors it will create (overwhelmingly many) colored messages that point to the error. py.test is Unfortunately not integrated into Eclipse, therefore there are no click-able error messages.
The documentation is written with reStructuredText markup, and it is compiled with the documentation generator Sphinx. Documentation is here:
- http://sphinx.pocoo.org/index.html
- http://docutils.sourceforge.net/docs/index.html (detailed reST documentation)
To create the whole website run the following command in directory doc/:
make html
The directory doc/ also contains a helper script, that generates the documentation and displays it in Firefox: test_wesite.sh. It can be run from Vim by typing:
!./test_wesite.sh
The src/ directory contains an automated release script: make_release.sh. It creates the packages in which the program is distributed, and an archive of the website in the directory src/dist/. It also tries to upload the packages to the Python Package Index. To make a release run:
./make_release.sh
Packages should be uploaded to Launchpad and to the Python Package Index.
Bugs and feature requests (set importance to wishlist) can be reported with JBidwatcher Companion’s bug tracker:
Bigger ideas should be saved as Blueprints on Launchpad: