add codecov stuff

Author: rnag

.coveragerc

@@ -1,5 +1,6 @@
 [run]
 branch = True
+source = dotwiz
 omit =
     */__version__.py
 
@@ -18,3 +19,5 @@ exclude_lines =
     if __name__ == .__main__.:
 
 ignore_errors = True
+omit =
+    tests/*

.github/workflows/release.yml

@@ -63,3 +63,20 @@ jobs:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
           skip_existing: true
+
+    - name: Generate coverage report
+      run: |
+        pip install pytest pytest-cov
+        pytest --cov=./ --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        directory: ./coverage/reports/
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        files: ./coverage1.xml,./coverage2.xml
+        flags: unittests
+        name: codecov-umbrella
+        path_to_write_report: ./coverage/codecov_report.txt
+        verbose: true

README.rst

@@ -21,21 +21,19 @@ Dot Wiz
      :alt: Updates
 
 
-A ``dict`` subclass that is *easy* to create, and supports *fast* dot access notation.
+A `blazing fast`_ ``dict`` subclass that enables *dot access* notation via Python
+attribute style. Nested ``dict`` and ``list`` values are automatically
+transformed as well.
 
 * Documentation: https://dotwiz.readthedocs.io.
 
-Installation
-------------
-
-The Dot Wiz library is available `on PyPI`_, and can be installed with ``pip``:
+Install
+-------
 
-.. code-block:: shell
+.. code-block:: console
 
     $ pip install dotwiz
 
-The ``dotwiz`` library officially supports **Python 3.6** or higher.
-
 Usage
 -----
 
@@ -63,11 +61,15 @@ creating a ``DotWiz`` object:
 
     from dotwiz import make_dot_wiz
 
-    dw = make_dot_wiz({'hello, world!': 123}, AnyKey='value', isActive=True)
+    dw = make_dot_wiz([('hello, world!', 123), ('easy: as~ pie?', True)],
+                      AnyKey='value')
+
+    print(dw)
+    #> DotWiz(AnyKey='value', hello, world!=123, easy: as~ pie?=True)
 
     assert dw['hello, world!'] == 123
+    assert dw['easy: as~ pie?']
     assert dw.AnyKey == 'value'
-    assert dw.isActive
 
 Features
 --------
@@ -83,8 +85,9 @@ Using a *dot-access* approach such as ``DotWiz`` can be up
 to **100x** faster than with `make_dataclass`_ from the ``dataclasses`` module.
 
 It's also about *5x* faster to create a ``DotWiz`` from a ``dict`` object
-as compared to other libraries such as ``prodict``, and up to *2x* faster
-in general to access keys by *dot* access.
+as compared to other libraries such as ``prodict`` -- or close to **15x** faster
+than creating a `Box`_ -- and up to *10x* faster in general to access keys
+by *dot* access -- or almost **30x** faster than accessing keys from a `DotMap`_!
 
 Contributing
 ------------
@@ -99,11 +102,14 @@ Credits
 
 This package was created with Cookiecutter_ and the `rnag/cookiecutter-pypackage`_ project template.
 
+.. _blazing fast: https://dotwiz.readthedocs.io/en/latest/benchmarks.html#results
 .. _Read The Docs: https://dotwiz.readthedocs.io
 .. _Installation: https://dotwiz.readthedocs.io/en/latest/installation.html
 .. _on PyPI: https://pypi.org/project/dotwiz/
 .. _make_dataclass: https://docs.python.org/3/library/dataclasses.html#dataclasses.make_dataclass
 .. _benchmark: https://github.com/rnag/dotwiz/tree/main/benchmarks
+.. _Box: https://github.com/cdgriffith/Box/wiki/Quick-Start
+.. _DotMap: https://pypi.org/project/dotmap
 .. _`Contributing`: https://dotwiz.readthedocs.io/en/latest/contributing.html
 .. _`open an issue`: https://github.com/rnag/dotwiz/issues
 .. _Cookiecutter: https://github.com/cookiecutter/cookiecutter

benchmarks/README.rst

@@ -65,19 +65,21 @@ better in an average case.
 Creating a dot-access ``dict``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The results indicate it is about **3x** faster to *create* a :class:`DotWiz`
+The results indicate it is about **5x** faster to *create* a :class:`DotWiz`
 instance (from a ``dict`` object) as compared to other competitor libraries
-such as ``dotsi`` and ``prodict`` - and up to **10x** faster than
-``box`` for example.
+such as ``dotsi`` and ``prodict`` - and up to **15x** faster than creating
+a `Box`_.
 
 Accessing keys by "dot" attribute
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The results show it is up to **2x** faster to *access* a key by dot
-attribute than ``prodict``, and about **7x** faster than with
-libraries such as ``dotmap``.
+The results show it is up to **10x** faster to *access* a key by dot
+attribute than ``prodict``, and about **30x** faster than accessing
+keys from a `DotMap`_ for example.
 
 .. _my post on SO: https://stackoverflow.com/a/72232461/10237506
 .. _benchmarks/: https://github.com/rnag/dotwiz/tree/main/benchmarks
 .. _virtual environment: https://realpython.com/python-virtual-environments-a-primer/
 .. _make_dataclass: https://docs.python.org/3/library/dataclasses.html#dataclasses.make_dataclass
+.. _Box: https://github.com/cdgriffith/Box/wiki/Quick-Start
+.. _DotMap: https://pypi.org/project/dotmap

docs/dotwiz.rst

@@ -4,14 +4,6 @@ dotwiz package
 Submodules
 ----------
 
-dotwiz.constants module
------------------------
-
-.. automodule:: dotwiz.constants
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 dotwiz.main module
 ------------------
 

requirements-dev.txt

@@ -4,14 +4,14 @@ wheel==0.37.1
 watchdog[watchmedo]==2.1.6
 flake8>=3  # pyup: ignore
 tox==3.24.5
+codecov==2.1.12
 coverage>=6.2
 Sphinx==4.4.0
 twine==3.8.0
 # Test requirements
 pytest==7.0.1
 pytest-benchmark[histogram]==3.4.1
 pytest-cov==3.0.0
-pytest-runner==5.3.1
 # Benchmarks
 dict2dot==0.1
 dotmap==1.3.30

setup.py

@@ -15,8 +15,7 @@
 test_requirements = [
     'pytest~=7.0.1',
     'pytest-benchmark[histogram]~=3.4.1',
-    'pytest-cov~=3.0.0',
-    'pytest-runner~=5.3.1'
+    'pytest-cov~=3.0.0'
 ]
 
 about = {}

tox.ini

@@ -26,7 +26,7 @@ deps =
 commands =
     pip install -U pip
     pytest --basetemp={envtmpdir}
-
+    codecov
 
 [flake8]
 ignore =