Merge pull request #46 from metaodi/develop

Release 0.6.0

.travis.yml

@@ -5,6 +5,7 @@ python:
 - '2.7'
 - '3.2'
 - '3.3'
+- '3.4'
 
 before_install:
 - sudo apt-get update -qq

CHANGELOG.md

@@ -4,6 +4,17 @@ This project follows [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## 0.6.0 - 2015-05-26
+### Added
+- SSL support for the API calls (thanks [Austin Hartzheim](http://austinhartzheim.me/)!)
+- Run tests on Python 3.4 as well
+- A bunch of new *Error classes (see below)
+- Dependency to 'Pygments' to enable syntax highlighting for [online documentation](http://osmapi.divshot.io)
+- [Contributing guidelines](https://github.com/metaodi/osmapi/blob/master/CONTRIBUTING.md) 
+
+### Changed
+- Changed generic `Exception` with more specific ones, so a client can catch those and react accordingly (no BC-break!)
+
 ## 0.5.0 - 2015-01-03
 ### Changed
 - BC-break: all dates are now parsed as datetime objects

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+If you want to participate in this project, please follow this guidline.
+
+Fork and clone this repository:
+
+```bash
+git clone [email protected]:your-username/osmapi.git
+```
+
+Install the dependencies using `pip`:
+
+```bash
+pip install -r requirements.txt
+pip install -r test-requirements.txt
+```
+
+Make sure the tests pass:
+
+```bash
+nosetests --verbose
+```
+
+You can even run the tests on different versions of Python with `tox`:
+
+```bash
+tox
+```
+
+To ensure a good quality of the code use `flake8` to check the code style:
+
+```bash
+flake8 --install-hook
+```
+
+## Create a pull request
+
+1. Choose the `develop` branch as a target for new/changed functionality, `master` should only be targeted for urgent bugfixes.
+2. While it's not strictly required, it's highly recommended to create a new branch on your fork for each pull request.
+3. Push to your fork and [submit a pull request][pr].
+4. Check if the [build ran successfully][ci] and try to improve your code if not.
+
+At this point you're waiting for my review.
+I might suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Follow the Python style guide ([PEP-8][pep8]).
+* Write a [good commit message][commit].
+
+[pr]: https://github.com/metaodi/osmapi/compare/
+[ci]: https://travis-ci.org/metaodi/osmapi
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html