Merge pull request #6 from snakypy/develop

News features

.python-version

@@ -1 +1 @@
-3.9.7
+3.9.9

docs/conf.py

@@ -22,9 +22,9 @@
 copyright = "2021, William C. Canin"
 author = "William C. Canin"
 
-version = "0.2.2"
+version = "0.3.0"
 # The full version, including alpha/beta/rc tags
-release = "0.2.2"
+release = "0.3.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -67,7 +67,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 source_suffix = {
     ".rst": "restructuredtext",

docs/helpers.rst

@@ -28,6 +28,23 @@ Module "math"
    :undoc-members:
    :show-inheritance:
 
+Subpackage "helpers.checking"
+------------------------------
+
+.. automodule:: snakypy.helpers.checking
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module "generic"
+~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: snakypy.helpers.checking.generic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 Subpackage "helpers.catches"
 ----------------------------
 
@@ -125,6 +142,14 @@ Module "removals"
    :undoc-members:
    :show-inheritance:
 
+Module "modifiers"
+~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: snakypy.helpers.os.modifiers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Subpackage "helpers.path"
 ---------------------------

pyproject.toml

@@ -8,7 +8,7 @@ license = "MIT license"
 name = "snakypy-helpers"
 readme = "README.rst"
 repository = "https://github.com/snakypy/snakypy-helpers"
-version = "0.2.2"
+version = "0.3.0"
 
 packages = [
   {include = "snakypy"},

snakypy/helpers/__init__.py

@@ -31,7 +31,7 @@
     "email": "contact.snakypy@gmail.com",
     "website": "https://snakypy.github.io",
     "github": "https://github.com/snakypy",
-    "version": "0.2.2",
+    "version": "0.3.0",
 }
 
 # Keep the versions the same on pyproject.toml and __init__.py

snakypy/helpers/calcs/__init__.py

@@ -1,2 +1,2 @@
 from .bmi import bmi
-from .math import compound_interest, fibonacci, percentage, simple_interest
+from .math import compound_interest, fibonacci, percentage, simple_interest, trunc

snakypy/helpers/calcs/math.py

@@ -176,4 +176,31 @@ def compound_interest(
     return format_dict
 
 
-__all__ = ["percentage", "fibonacci", "compound_interest", "simple_interest"]
+def trunc(number, n_digits=None, *, is_round=False):
+    """
+        Function to truncate float numbers
+
+        >>> from snakypy import helpers
+        >>> helpers.calcs.trunc(1.9989, 2)
+        1.99
+        >>> helpers.calcs.trunc(1.9989, 2, is_round=True)
+        2.0
+
+    Args:
+        number (float): Must receive a float number
+
+        n_digits (int): An integer must be passed to define the number of places after the comma.
+
+        is_round (bool): If the value is TRue, round the number.
+
+        Returns:
+            Returns a float number
+    """
+    if is_round:
+        return round(number, n_digits)
+    if n_digits and not is_round:
+        return int(number * 10 ** n_digits) / 10 ** n_digits
+    return number
+
+
+__all__ = ["percentage", "fibonacci", "compound_interest", "simple_interest", "trunc"]

snakypy/helpers/catches/__init__.py

@@ -1,2 +1,2 @@
 from .finders import find_objects, is_tool, tools_requirements
-from .generic import extension, shell, whoami
+from .generic import extension

snakypy/helpers/catches/finders.py

@@ -2,8 +2,6 @@
 from os.path import exists, isdir, join
 from shutil import which
 
-from snakypy.helpers.decorators import only_linux
-
 
 def find_objects(
     directory: str, /, files: tuple = (), folders: tuple = (), by_extension: tuple = ()
@@ -60,10 +58,9 @@ def find_objects(
         )
 
 
-@only_linux
 def is_tool(*args: str) -> bool:
     """
-        Searches if a tool is installed on the machine. (Linux systems only)
+        Searches if a tool is installed on the machine.
 
         >>> from snakypy import helpers
         >>> helpers.catches.is_tool("ls")
@@ -82,7 +79,6 @@ def is_tool(*args: str) -> bool:
     return False
 
 
-@only_linux
 def tools_requirements(*args) -> bool:
     """
         Search required tools if you can not burst an exception

snakypy/helpers/catches/generic.py

@@ -1,47 +1,6 @@
 import re
-from os import environ, popen
 from os.path import splitext
 
-from snakypy.helpers.decorators import only_linux
-
-
-@only_linux
-def whoami() -> str:
-    """
-        Get the currently logged in user.
-
-        >>> from snakypy import helpers
-        >>> helpers.catches.whoami()
-        'william'
-
-    Returns:
-         [str] -- Returns the name of the current user.
-    """
-    return str(popen("whoami").read()).replace("\n", "")
-
-
-@only_linux
-def shell() -> str:
-    """
-    Function to get the currently activated shell.
-
-    >>> from snakypy import helpers
-    >>> helpers.catches.shell()
-    'sh'
-
-    Returns:
-        [str] -- Returns the name of the current shell.
-    """
-    try:
-        get_shell = environ["SHELL"]
-    except KeyError:
-        return ""
-
-    if "/" in get_shell:
-        return get_shell.strip("\n").strip("").split("/")[-1]
-
-    return get_shell
-
 
 def extension(filename: str, dots: bool = False) -> str:
     """Get a file extension
@@ -53,7 +12,7 @@ def extension(filename: str, dots: bool = False) -> str:
     >>> helpers.catches.extension(file, dots=True)
     'tar.gz'
 
-    or using from
+    or
 
     >>> from snakypy.helpers.catches import extension
     >>> file = '/tmp/file.tar.gz'
@@ -85,4 +44,4 @@ def extension(filename: str, dots: bool = False) -> str:
         return ext
 
 
-__all__ = ["whoami", "shell", "extension"]
+__all__ = ["extension"]

snakypy/helpers/checking/__init__.py

@@ -0,0 +1,8 @@
+from .generic import (
+    is_blank_file,
+    is_hidden,
+    is_palindrome,
+    shell,
+    turned_palindrome,
+    whoami,
+)