Added github actions

Author: LucaCappelletti94

.github/workflows/python.yml

@@ -0,0 +1,37 @@
+name: Python Package CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ".[test]"
+
+    - name: Run tests
+      run: |
+        pytest
+
+    - name: Build package
+      run: |
+        python -m pip install wheel
+        python setup.py sdist bdist_wheel

README.rst

@@ -7,7 +7,7 @@
 
 Transpose Dictionary
 ======================
-|pip| |downloads|
+|pip| |downloads| |github|
 
 Simple python package to transpose python dictionaries.
 
@@ -62,6 +62,10 @@ The software is released under the MIT license.
 .. |pip| image:: https://badge.fury.io/py/transpose-dict.svg
     :target: https://badge.fury.io/py/transpose-dict
 
-.. |downloads| image:: https://pepy.tech/badge/deflate-dict
-    :target: https://pepy.tech/badge/deflate-dict
-    :alt: Pypi total project downloads 
+.. |downloads| image:: https://pepy.tech/badge/transpose-dict
+    :target: https://pepy.tech/badge/transpose-dict
+    :alt: Pypi total project downloads 
+
+.. |github| image:: https://github.com/LucaCappelletti94/transpose-dict/actions/workflows/python.yml/badge.svg
+    :target: https://github.com/LucaCappelletti94/dict_hash/actions/
+    :alt: Github Actions

setup.py

@@ -1,8 +1,6 @@
+"""Setup script for the package."""
 import os
 import re
-import sys
-# To use a consistent encoding
-from codecs import open
 from os import path
 
 from setuptools import find_packages, setup
@@ -15,7 +13,7 @@
 
 
 def read(*parts):
-    with open(os.path.join(here, *parts), 'r') as fp:
+    with open(os.path.join(here, *parts), 'r', encoding="utf8") as fp:
         return fp.read()
 
 
@@ -30,7 +28,7 @@ def find_version(*file_paths):
 
 __version__ = find_version("transpose_dict", "__version__.py")
 
-test_deps = ['pytest', 'pytest-cov', 'coveralls']
+test_deps = ['pytest', 'pytest-cov']
 
 extras = {
     'test': test_deps,

transpose_dict/__init__.py

@@ -1,10 +1,7 @@
 """Module providing tools to transpose dictionaries."""
-from support_developer import support_luca
-from .transpose_dict import transpose_dict
+from transpose_dict.transpose_dict import transpose_dict
 
 # Create an alias in order to make code more compact
 TD = transpose_dict
 
-support_luca("transpose_dict")
-
 __all__ = ["transpose_dict", "TD"]

transpose_dict/__version__.py

@@ -1 +1,2 @@
-__version__ = "1.1.3"
+"""Current version of the transpose-dict package."""
+__version__ = "1.1.3"

transpose_dict/transpose_dict.py

@@ -1,45 +1,48 @@
 """Module providing tooling to elaborate a dictionary object."""
+
 from typing import Dict, Set, Any
 
 
-def dict_of_dict(D: Dict) -> bool:
+def is_dict_of_dict(dictionary: Dict) -> bool:
     """Return whether given dictionary contains only dictionaries.
 
     Parameters
     -------------------------------
-    D: Dict
+    dictionary: Dict
         Dictionary of which to determine if contains only dictionaries.
 
     Returns
     -------------------------------
     Boolean representing whether given dictionary contains only dictionaries.
     """
-    return all(isinstance(d, dict) for d in D.values())
+    return all(isinstance(value, dict) for value in dictionary.values())
 
 
-def min_depth(D: Dict) -> int:
+def min_depth(dictionary: Dict) -> int:
     """Return minimum depth of given dictionary.
 
     Parameters
     -------------------------------
-    D: Dict
+    dictionary: Dict
         Dictionary of which to determine the width
 
     Returns
     -------------------------------
     Minimum depth of dictionary.
     """
-    return 1 + min(
-        min_depth(d) for d in D.values()
-    ) if dict_of_dict(D) else 0
+    return (
+        1 + min(min_depth(value) for value in dictionary.values())
+        if is_dict_of_dict(dictionary)
+        else 0
+    )
 
 
-def axis_keys(D: Dict, axis: int) -> Set[Any]:
+def axis_keys(dictionary: Dict, axis: int) -> Set[Any]:
     """Return set of keys at given axis.
 
     Parameters
     -------------------------------
-    D: Dict
+    dictionary: Dict
         Dictionary to determine keys of.
     Axis:int
         Depth of keys.
@@ -48,17 +51,19 @@ def axis_keys(D: Dict, axis: int) -> Set[Any]:
     -------------------------------
     The set of keys at given axis
     """
-    return set.union(*[
-        axis_keys(d, axis-1) for d in D.values()
-    ]) if axis else set(D.keys())
+    return (
+        set.union(*[axis_keys(value, axis - 1) for value in dictionary.values()])
+        if axis
+        else set(dictionary.keys())
+    )
 
 
-def reindex_key(D: Dict, key: Any, axis: int) -> Dict:
+def reindex_key(dictionary: Dict, key: Any, axis: int) -> Dict:
     """Return reindex dictionary to given key.
 
     Parameters
     -------------------------------
-    D: Dict
+    dictionary: Dict
         Dictionary to reindex.
     key: Any
         Key to reindex.
@@ -70,34 +75,30 @@ def reindex_key(D: Dict, key: Any, axis: int) -> Dict:
     Reindexed dictionary.
     """
     if axis == 0:
-        return D.get(key)
+        return dictionary.get(key)
     return {
         subkey: value
-        for subkey, value in
-        (
+        for subkey, value in (
             (
                 subkey,
-                value
-                if not isinstance(value, dict)
-                else
-                reindex_key(
-                    value,
-                    key,
-                    axis-1
-                )
+                (
+                    value
+                    if not isinstance(value, dict)
+                    else reindex_key(value, key, axis - 1)
+                ),
             )
-            for subkey, value in D.items()
+            for subkey, value in dictionary.items()
         )
         if value is not None and (not isinstance(value, dict) or len(value) != 0)
     }
 
 
-def transpose_dict(D: Dict, axis: int) -> Dict:
+def transpose_dict(dictionary: Dict, axis: int) -> Dict:
     """Transpose given dictionary on given axis.
 
     Parameters
     -------------------------------
-    D: Dict
+    dictionary: Dict
         Dictionary to transpose.
     axis: int
         Axis to traspose.
@@ -107,6 +108,5 @@ def transpose_dict(D: Dict, axis: int) -> Dict:
     Transposed dictionary.
     """
     return {
-        key: reindex_key(D, key, axis)
-        for key in axis_keys(D, axis)
+        key: reindex_key(dictionary, key, axis) for key in axis_keys(dictionary, axis)
     }