documentation, setup, coverage, and tox configuration, modification t…

…est case, pipfile clean and update

.coveragerc

@@ -0,0 +1,25 @@
+[run]
+branch = true
+data_file = .coverage
+
+[report]
+omit =
+    */site-packages/*
+    */.virtualenvs/*
+    */tests/*
+    */.tox/*
+    */.idea/*
+    */docs/*
+    setup.py
+show_missing = True
+exclude_lines =
+    raise NotImplementedError
+    def __repr__
+    def __str__
+    raise AssertionError
+    raise NotImplementedError
+    raise NotImplemented
+ignore_errors = True
+
+[html]
+directory = htmlcov

Pipfile

@@ -7,19 +7,17 @@ name = "pypi"
 
 [packages]
 
-nose = "==1.3.7"
-coverage = "==4.3.4"
-
 
 [dev-packages]
 
-pytest = "*"
-coverage = "*"
 bumpversion = "*"
-"flake8" = "*"
 codecov = "*"
+coverage = "*"
+"flake8" = "*"
+pytest = "*"
+setuptools-scm = "*"
 sphinx = "*"
 sphinx-rtd-theme = "*"
-tox-pyenv = "*"
 tox = "*"
-setuptools-scm = "*"
+tox-pyenv = "*"
+twine = "*"

README.rst

@@ -5,6 +5,33 @@ Value Object
 :Info: DDD Value Object implementation.
 :Author: Paweł Zadrożny @pawelzny <pawel.zny@gmail.com>
 
+.. image:: https://circleci.com/gh/pawelzny/vo/tree/master.svg?style=shield&circle-token=bcc877f72e384d82ddd044b88de1faca2ff774bc
+   :target: https://circleci.com/gh/pawelzny/vo/tree/master
+   :alt: CI Status
+
+.. image:: https://readthedocs.org/projects/vo/badge/?version=latest
+   :target: http://vo.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/v/vo.svg
+   :target: https://pypi.org/project/vo/
+   :alt: PyPI Repository Status
+
+.. image:: https://img.shields.io/github/release/pawelzny/vo.svg
+   :target: https://github.com/pawelzny/vo
+   :alt: Release Status
+
+.. image:: https://img.shields.io/pypi/status/vo.svg
+   :target: https://pypi.org/project/vo/
+   :alt: Project Status
+
+.. image:: https://img.shields.io/pypi/pyversions/vo.svg
+   :target: https://pypi.org/project/vo/
+   :alt: Supported python versions
+
+.. image:: https://img.shields.io/pypi/l/vo.svg
+   :target: https://github.com/pawelzny/vo/blob/master/LICENSE
+   :alt: License
 
 Features
 ========
@@ -23,23 +50,37 @@ Installation
     pip install vo
 
 
-**Package**: https://pypi.python.org/pypi/vo
+**Package**: https://pypi.org/project/vo/
+
+
+Documentation
+=============
+
+Read full documentation on: http://vo.readthedocs.io
 
 
 Quick Example
 =============
 
 .. code:: python
 
-    from vo import Value
+   >>> from vo import Value
+   >>> value = Value(test=True, some_text="I am some text string")
+   >>> value == value
+   True
+
+   >>> value_clone = Value(some_text="I am some text string", test=True)
+   >>> value == value_clone
+   True
 
-    value1 = Value(test=True, some_text="I am some text string")
-    value2 = Value(some_text="I am some text string", test=True)
-    value3 = Value(purpose_of_life=42)
+   >>> value is value_clone
+   False
 
-    assert(value1 == value1)  # True
-    assert(value1 == value2)  # True
-    assert(value1 == value3)  # False
+   >>> value_truth = Value(purpose_of_life=42)
+   >>> value == value_truth
+   False
 
-    print(value3.purpose_of_life)  # 42
-    print(value3['purpose_of_life'])  # 42
+   >>> value_truth.purpose_of_life
+   42
+   >>> value_truth['purpose_of_life']
+   42