Merge pull request #359 from BigBrotherBot/prepare-merge2

v1.10 stable release

.bumpversion.cfg

@@ -0,0 +1,9 @@
+[bumpversion]
+current_version = 1.10.10
+
+[bumpversion:file:b3/__init__.py]
+
+[bumpversion:file:b3/PKG-INFO]
+
+[bumpversion:file:setup.py]
+

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+omit =
+	tests/*
+	b3/lib/*
+	b3/tools/*
+	b3/fake

.gitignore

@@ -1,4 +1,5 @@
 desktop.ini
+.idea/*
 *.pyc
 *.log
 *.log.1
@@ -9,9 +10,8 @@ desktop.ini
 *.orig
 *.patch
 *.lnk
+b3.egg-info
+build
+dist
 releases/*
-conf/b3.xml
-build/*
-py2exe_builder/dist_py2exe/
-py2exe_builder/Output/
-.idea/*
+b3/docs/user_documentation/_build/*

.travis.yml

@@ -1,9 +1,54 @@
 # TravisCI config file. See http://travis-ci.org
 language: python
+
 python:
-  - 2.6
   - 2.7
-# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
-install: pip install pysqlite MySQL-python unittest2 mockito nose-exclude --use-mirrors
-# command to run tests, e.g. python setup.py test
-script: nosetests --where=tests --exclude-dir=tests/storage/
+
+env:
+  matrix:
+    # jobs environment variables
+    - TEST=core
+    - TEST=plugins
+    - TEST=build
+  global:
+    # global environment variables
+    - MYSQL_TEST_HOST=127.0.0.1
+    - MYSQL_TEST_USER=travis MYSQL_TEST_PASSWORD=''
+    - MYSQL_TEST_DB=b3_test
+    - POSTGRESQL_TEST_HOST=127.0.0.1
+    - POSTGRESQL_TEST_USER=postgres
+    - POSTGRESQL_TEST_PASSWORD=''
+    - POSTGRESQL_TEST_DB=b3_test
+
+addons:
+  # select postgresql version
+  postgresql: "9.3"
+
+cache:
+  # cache pip installs across jobs
+  - pip
+
+install:
+  # install requirements
+  - ./scripts/install-deps-${TEST}.sh
+
+before_script:
+  # create postgresql database
+  - psql -c "CREATE DATABASE b3_test WITH OWNER = postgres ENCODING = 'UTF8';" -U postgres
+
+script:
+  # execute current job
+  - ./scripts/start-tests-${TEST}.sh
+
+after_success:
+  # report tests coverage if we are running tests
+  - if [ "${TEST}" != "build" ]; then pip install coveralls && coveralls; fi
+
+notifications:
+  # send notifications to gitter
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/489374443a557d989111
+    on_success: always  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # default: never

CHANGELOG

@@ -1,12 +1,3 @@
-1.9.1 -> 1.9.2
-----
-A list of changed files is available after release here:
-http://github.com/BigBrotherBot/big-brother-bot/compare/v1.9.1...v1.9.2
-----
-
-Minor release to fix an installation problem when using the easy_install tool with python 2.6
-
-
 1.9.0 -> 1.9.1
 ----
 A list of changed files is available after release here:

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# How to contribute
+
+With the many games the B3 project supports, third party patches are essential to keep the project great. There are a
+few guidelines that we need contributors to follow so that we can have a chance of keeping B3 project as clean and 
+organized as possible.
+
+****************
+
+## Contributing Issues
+
+Issues submitted on Github must be technically documented with the aim that any contributor trying to fix your issue 
+should have enough information to understand and reproduce the issue and validate the fix.
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Search for a similar issue.
+* Submit your issue, assuming one does not already exist.
+* Clearly describe the issue including:
+    * Steps to reproduce.
+    * Expected results.
+    * Actual results.
+* Make sure you fill in the earliest version number of B3 that you know has the issue.
+
+## Contributing Code
+
+We prefer contributors to submit their code change throught GitHub [pull requests](http://help.github.com/send-pull-requests/). 
+If you are not able to send pull requests,  you can submit patches on the B3 forums provided that your patch is small 
+enough to be easily merged and tested.
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* [Fork](https://github.com/BigBrotherBot/big-brother-bot/fork) this repository on GitHub.
+* Create a topic branch from where you want to base your work.
+    * This is usually **NOT** the `master` branch. You should push your changes to a `release` branch. 
+    * Please avoid working directly on the `master` branch.
+* Make sure your code follows our [coding style](#coding-style)
+* Make commits of logical units.
+* Make sure your commit messages are in the proper format (example below): 
+```
+   [STORAGE] this commit is changing code in the storage module
+   
+   You can put a description of the changes being carried by the commit in the body of the 
+   commit message while keeping the first line of the commit message as short as possible. 
+   The first line is a real life imperative statement which may contain the link to the 
+   issue being fixed by the commit. The body describes the behavior without the patch, why 
+   this is a problem, and how the patch fixes the problem when applied.
+```
+* Make sure you have added all the necessary tests for your changes.
+* Make sure that all the provided tests pass before sending a pull request.
+* Squash multiple trivial commits into a single commit.
+
+# Submitting Your Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the BigBrotherBot/big-brother-bot repository.
+* Update the issue to mark that you have submitted code and are ready for it to be reviewed.
+* Include a link to the pull request in the issue.
+* A pull request should contain a single feature/bugfix. If you need to send multiple features/bugfixes please
+  use separate pull requests.
+
+## Coding Style
+
+Different programmers use to write code in different ways. Without the usage of coding conventions, a project source code
+may become unreadable and eventually not understandable. While B3 doesn't strictly follows PEP-8 coding conventions, it 
+is required that your code follows the following guidelines:
+
+* Break long lines after 110 characters (max GitHub web-viewer capacity)
+* Do not indent using `TAB`: use 4 spaces to indent your code.
+* Do not use python built-in names to name your variables.
+* Document your code (example below):
+```python
+def myFunc(self, param1, param2):
+   """
+   Put the description here.
+   :param param1: The first parameter.
+   :param param2: The second parameter.
+   :raise MyError: The exception class if your function may raise an exception.
+   :return: The return value of your function.
+   """"
+   ...
+```
+* Always use `self` for the first argument to instance methods.
+* Always use `cls` for the first argument to class methods.
+* Use uppercase for SQL keywords and lowercase for SQL identifiers.
+* When catching exceptions, mention specific exceptions whenever possible instead of using only the `except` keyword.
+* When you add new python modules remember to place the licensing on the top of the file.
+* Remember to update the changelog you can find in python modules whenever you make changes.
+* Last but not least: comment your code!
+
+****************
+
+# Additional Resources
+
+* [Bug tracker](https://github.com/BigBrotherBot/big-brother-bot/issues)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

MANIFEST.in

@@ -2,7 +2,12 @@ include *.py
 include b3_run.py
 include b3/sql/*.sql
 include CHANGELOG README.md b3/PKG-INFO *.txt
-include b3/conf/*.xml b3/conf/*.ini
+include b3/conf/*.xml
+include b3/conf/*.ini
 include b3/conf/templates/*.tpl
-exclude py2exe_builder/*
 exclude .idea/*
+exclude tests/*
+exclude setup.cfg
+exclude setup.py
+exclude build-requirements.txt
+exclude MANIFEST.in