Merge branch 'refactor' of https://github.com/jkanche/mopsy into refa…

…ctor

.github/workflows/pypi-publish.yml

@@ -48,4 +48,4 @@ jobs:
       uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
       with:
         user: __token__
-        password: ${{ secrets.PYPI_PASSWORD }}
+        password: ${{ secrets.PYPI_PASSWORD }}

CHANGELOG.md

@@ -1,11 +1,11 @@
 # Changelog
 
 
-## Version 0.2.0 
+## Version 0.2.0
 - Support multi apply
 
 ## Version 0.1 (development)
 
 - first release
-- performs some basic operations over numpy or scipy matrices. 
+- performs some basic operations over numpy or scipy matrices.
 - provides apply method so user can extend the underlying logic to any function

docs/requirements.txt

@@ -1,7 +1,7 @@
+furo
 # Requirements file for ReadTheDocs, check .readthedocs.yml.
 # To build the module reference correctly, make sure every external package
 # under `install_requires` in `setup.cfg` is also listed here!
 # sphinx_rtd_theme
 recommonmark
 sphinx>=3.2.1
-furo

docs/tutorial.md

@@ -50,7 +50,7 @@ apply(nz_func, mat, axis=1)
 
 ## Multiple functions
 
-`mopsy` also supports applying multiple functions at the same time. 
+`mopsy` also supports applying multiple functions at the same time.
 
 ```python
 from mopsy import multi_apply
@@ -73,4 +73,4 @@ tmat_wrow = append_row(mat, np.array([0, 0, 0, 0, 0]))
 tmat_wcol = append_col(mat, np.array([[0], [0], [0], [0], [0]]))
 ```
 
-That's all for today! 
+That's all for today!

setup.py

@@ -1,10 +1,8 @@
-"""
-    Setup file for mopsy.
-    Use setup.cfg to configure your project.
+"""Setup file for mopsy. Use setup.cfg to configure your project.
 
-    This file was generated with PyScaffold 4.1.1.
-    PyScaffold helps you to put up the scaffold of your new Python project.
-    Learn more under: https://pyscaffold.org/
+This file was generated with PyScaffold 4.1.1.
+PyScaffold helps you to put up the scaffold of your new Python project.
+Learn more under: https://pyscaffold.org/
 """
 from setuptools import setup
 

src/mopsy/checkutils.py

@@ -8,7 +8,7 @@
 
 
 def check_axis(axis: Union[int, bool]):
-    """Check if axis has a correct value
+    """Check if axis has a correct value.
 
     Args:
         axis:

src/mopsy/helpers.py

@@ -1,5 +1,5 @@
 from statistics import mean, median
-from typing import Any, Callable, Sequence, Union
+from typing import Callable, Sequence, Union
 
 import numpy
 import scipy

src/mopsy/mops.py

@@ -11,7 +11,7 @@
 
 
 class Mops:
-    """Base class for all matrix operations"""
+    """Base class for all matrix operations."""
 
     def __init__(self, mat, non_zero: bool = False) -> None:
         """Intialize the matrix.
@@ -108,9 +108,8 @@ def multi_apply(
         group: list = None,
         axis: int = 0,
     ) -> Tuple[np.ndarray, Optional[Sequence]]:
-        """Apply multiple functions, the first axis
-        of the ndarray specifies the results of the inputs functions in
-        the same order.
+        """Apply multiple functions, the first axis of the ndarray specifies the results of the inputs functions in the
+        same order.
 
         Args:
             func:

src/mopsy/nops.py

@@ -10,7 +10,7 @@
 
 
 class Nops(Mops):
-    """Internal representation for numpy arrays"""
+    """Internal representation for numpy arrays."""
 
     def __init__(self, mat: np.ndarray, non_zero: bool = False) -> None:
         super().__init__(mat, non_zero=non_zero)
@@ -23,7 +23,7 @@ def iter(
         Args:
             group:
                 Group variable. Defaults to None.
-            
+
             axis:
                 0 for rows, 1 for columns. Defaults to 0.
 

src/mopsy/sops.py

@@ -133,9 +133,8 @@ def multi_apply(
         group: list = None,
         axis: Union[int, bool] = 0,
     ) -> Tuple[np.ndarray, Optional[Sequence]]:
-        """Apply multiple functions, the first axis
-        of the ndarray specifies the results of the inputs functions in
-        the same order.
+        """Apply multiple functions, the first axis of the ndarray specifies the results of the inputs functions in the
+        same order.
 
         Args:
             func:

src/mopsy/utils.py

@@ -12,7 +12,7 @@
 
 
 def get_matrix_type(mat: Union[np.ndarray, sp.spmatrix], non_zero: bool = False):
-    """Get an internal matrix state
+    """Get an internal matrix state.
 
     Args:
         mat:

tests/conftest.py

@@ -1,10 +1,9 @@
-"""
-    Dummy conftest.py for mopsy.
+"""Dummy conftest.py for mopsy.
 
-    If you don't know what this is for, just leave it empty.
-    Read more about conftest.py under:
-    - https://docs.pytest.org/en/stable/fixture.html
-    - https://docs.pytest.org/en/stable/writing_plugins.html
+If you don't know what this is for, just leave it empty.
+Read more about conftest.py under:
+- https://docs.pytest.org/en/stable/fixture.html
+- https://docs.pytest.org/en/stable/writing_plugins.html
 """
 
 # import pytest

tests/test_interface.py

@@ -19,4 +19,3 @@ def test_apply_cols():
 def test_multiapply_cols():
     rmat = multi_apply([mean], mat, 1, None, False)
     assert rmat is not None
-

tests/test_sparse_add.py

@@ -10,7 +10,7 @@
 def test_sparse_add_row():
     mat = eye(5).tocsr()
     tmat = sparse_append(mat, np.array([0, 0, 0, 0, 0]), axis=0)
-    
+
     assert tmat is not None
     assert tmat.shape[0] == mat.shape[0] + 1
     assert type(tmat) == type(mat)
@@ -23,4 +23,3 @@ def test_sparse_add_col():
     assert tmat is not None
     assert tmat.shape[1] == mat.shape[1] + 1
     assert type(tmat) == type(mat)
-