PROJ_CODING

Bithopper Coding Style

INDENTS
4 spaces per indent. Don't use tab characters. Don't use 3 spaces.

COMMENTS
Comments are really nice. Docstrings are also nice. We don't have enough of either.

ADDING A NEW FEATURE
I prefer new features be added as new files and modules. If they can't reasonably be
done like that or fit within a current module use that. If in doubt ask.

As much as possible please leave core modules as they are and extend via "hooks"
and plugins. To see an example plugin see plugins/hookexample/__init__.py

Convention for adding new plugin configuration to bh.cfg is to prefix with "plugin."
Convention is to use __init__.py to bootstrap the plugin and the bulk of the logic
go into a seperate .py file. This makes it easier to work with multiple plugins.

WHY DOES POOL.PY DO EVERYTHING?
Because I haven't had time to split it and clean it up.
1/30/2012: clr: It actually is slowly being killed. All of the info is being
spun off to btcnet_info. And then we can replace it in one sweet move.

bH could support scraping after logging in with mechanize. Small script example included
(http://wwwsearch.sourceforge.net/mechanize/)

---------------------------------------------------------------------------------------

Bug-issues list:


ajax updates move scroll                     (https://github.com/c00w/bitHopper/issues/69)

UPSTREAM: WSGI server tries to finish closed connections
                                             (https://github.com/c00w/bitHopper/issues/262)

UPSTREAM: CGMINER w/ Multiple Coins Crashes  (https://github.com/c00w/bitHopper/issues/343)

LP Workbench data not displaying             (https://github.com/c00w/bitHopper/issues/493)

Can't get {user} to work - user: in user.cfg (https://github.com/c00w/bitHopper/issues/502)

bitHopper stalled                            (https://github.com/c00w/bitHopper/issues/535)

nmcbit.com duration calculation bad          (https://github.com/c00w/bitHopper/issues/539)
---------------------------------------------------------------------------------------

Future to-do list:


Autoupdate pools.cfg                         (https://github.com/c00w/bitHopper/issues/361)

Extend Plugin Framework                      (https://github.com/c00w/bitHopper/issues/368)

Orange thing for mine_force/lp and lp time next to pool
                                             (https://github.com/c00w/bitHopper/issues/408)

Sort lpworkbench servers                     (https://github.com/c00w/bitHopper/issues/418)

Store the duration in the db                 (https://github.com/c00w/bitHopper/issues/420)

Display Time since last LP on /stats# page next to round duration
                                             (https://github.com/c00w/bitHopper/issues/422)

Add role: mine_fhop                          (https://github.com/c00w/bitHopper/issues/431)