Updated README

Author: tomasbedrich

.editorconfig

@@ -0,0 +1,13 @@
+; This is an ini style configuration. See http://editorconfig.org/ for more information on this file.
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4

CONTRIBUTING.rst

@@ -3,4 +3,9 @@ Contributing
 ===============================================================================
 
 
-TODO
+In a nutshell:
+
+- follow `PEP8 style guide <https://www.python.org/dev/peps/pep-0008/>` with **double quotes** and
+  line length of **100 characters (or 120 if absolutely nescessary)**
+- before push, run with :code:`python3 setup.py test`, then ensure **all tests are passing** and
+  **the coverage is above 95%**

README.rst

@@ -30,25 +30,26 @@ Installation
 
 Stable version - using pip:
 
-.. code:: bash
+.. code-block:: bash
 
     pip install pycaching
 
 Dev version - manually from GIT:
 
-.. code:: bash
+.. code-block:: bash
 
     git clone https://github.com/tomasbedrich/pycaching.git
-    pip install ./pycaching
+    cd pycaching
+    pip install .
 
 Pycaching has following requirements:
 
 .. code::
 
-  Python>=3.4
-  requests >= 2.8
-  beautifulsoup4 >= 4.4
-  geopy>=1.11
+    Python>=3.4
+    requests>=2.8
+    beautifulsoup4>=4.4
+    geopy>=1.11
 
 
 Examples
@@ -57,9 +58,9 @@ Examples
 Login
 ---------------------------------------------------------------------------------------------------
 
-Simly call ``pycaching.login`` method and it will do all things for you.
+Simly call :meth:`.login` method and it will do all things for you.
 
-.. code:: python
+.. code-block:: python
 
     import pycaching
     geocaching = pycaching.login("user", "pass")
@@ -69,27 +70,27 @@ If you won't provide an username or password, pycaching will try to load
 parse it as JSON and use the keys ``username`` and ``password`` from that file
 as login credentials.
 
-.. code:: python
+.. code-block:: python
 
     import pycaching
     geocaching = pycaching.login()  # assume the .gc_credentials file is presented
 
 Load a cache details
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     cache = geocaching.get_cache("GC1PAR2")
     print(cache.name)  # cache.load() is automatically called
     print(cache.location)  # stored in cache, printed immediately
 
-This uses lazy loading, so the ``Cache`` object is created immediately and the
+This uses lazy loading, so the :class:`.Cache` object is created immediately and the
 page is loaded when needed (accessing the name).
 
 You can use different method of loading cache details. It will be much faster,
 but it will load less details:
 
-.. code:: python
+.. code-block:: python
 
     cache = geocaching.get_cache("GC1PAR2")
     cache.load_quick()  # takes a small while
@@ -98,32 +99,32 @@ but it will load less details:
 
 You can also load a logbook for cache:
 
-.. code:: python
+.. code-block:: python
 
     for log in cache.load_logbook(limit=200):
         print(log.visited, log.type, log.author, log.text)
 
 Or its trackables:
 
-.. code:: python
+.. code-block:: python
 
     for trackable in cache.load_trackables(limit=5):
         print(trackable.name)
 
 Post a log to cache
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     geocaching.post_log("GC1PAR2", "Found cache in the rain. Nice place, TFTC!")
 
-It is also possible to call post_log on ``Cache`` object, but you would have
-to create ``Log`` object manually and pass it to this method.
+It is also possible to call post_log on :class:`.Cache` object, but you would have
+to create :class:`.Log` object manually and pass it to this method.
 
 Search for all traditional caches around
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     from pycaching import Point
     from pycaching.cache import Type
@@ -134,14 +135,14 @@ Search for all traditional caches around
         if cache.type == Type.traditional:
             print(cache.name)
 
-Notice the ``limit`` in search function. It is because ``search()``
+Notice the ``limit`` in search function. It is because :meth:`.Geocaching.search`
 returns a generator object, which would fetch the caches forever in case
 of simple loop.
 
 Geocode adress and search around
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     point = geocaching.geocode("Prague")
 
@@ -151,7 +152,7 @@ Geocode adress and search around
 Find caches with their approximate locations in some area
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     from pycaching import Point, Rectangle
 
@@ -164,7 +165,7 @@ Find caches with their approximate locations in some area
 Load a trackable details
 ---------------------------------------------------------------------------------------------------
 
-.. code:: python
+.. code-block:: python
 
     trackable = geocaching.get_trackable("TB3ZGT2")
     print(trackable.name, trackable.goal, trackable.description, trackable.location)

setup.py

@@ -2,6 +2,22 @@
 
 import os
 from setuptools import setup
+from setuptools.command.test import test as TestCommand
+
+
+# see http://fgimian.github.io/blog/2014/04/27/running-nose-tests-with-plugins-using-the-python-setuptools-test-command
+class NoseTestCommand(TestCommand):
+
+    def finalize_options(self):
+        TestCommand.finalize_options(self)
+        self.test_args = []
+        self.test_suite = True
+
+    def run_tests(self):
+        # Run nose ensuring that argv simulates running nosetests directly
+        import nose
+        nose.run_exit(argv=["nosetests", "--with-coverage", "--cover-package=pycaching"])
+
 
 root = os.path.dirname(__file__) or "."
 f = open(os.path.join(root, "README.rst"))
@@ -20,7 +36,8 @@
     "long_description":    long_description,
     "keywords":            ["geocaching", "crawler", "geocache", "cache", "search", "geocode", "travelbug"],
     "install_requires":    ["requests >= 2.8", "beautifulsoup4 >= 4.4", "geopy >= 1.11"],
-    "test_suite":          "test"
+    "setup_requires":      ["nose >= 1.3", "flake8 >= 2.4.0", "coverage >= 3.7"],
+    "cmdclass":            {"test": NoseTestCommand},
 }
 
 setup(**info)