Merge pull request #1 from bcrawford39GT/initial_setup

initial setup

Author: bcrawford39GT

.gitignore

@@ -0,0 +1,68 @@
+test-output.xml
+*.py[cod]
+*.ipynb_checkpoints
+
+# C extensions
+*.so
+
+# github
+**/.DS_Store
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+.pypirc
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+htmlcov
+.cache
+.pytest_cache/
+
+# Translations
+*.mo
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+# PyCharm
+.idea
+.idea/*
+
+# VSCode
+.vscode
+.vscode/*
+
+# Vagrant
+.vagrant
+Vagrantfile
+
+# rope project settings
+.ropeproject
+
+#conda version
+__conda_version__.txt
+github_tutorial/version.py
+
+#virtual env
+.env/
+
+

LICENSE

@@ -0,0 +1,8 @@
+name: github_tutorial
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - numpy
+  - pytest
+  - pip

environment.yml

@@ -0,0 +1,36 @@
+from github_tutorial.main_functions.main_functions  import math_function_class 
+
+# enter the two (2) values to use
+entered_value_0 = 100
+entered_value_1 = 2
+
+# set the math_function_class
+math_variable = math_function_class(entered_value_0, entered_value_1)
+
+# print the math_variable (i.e., math_function_class) and list its type
+print(f"\n")
+print(f"math_variable = {math_variable}")
+print(f"type(math_variable) = {type(math_variable)}\n")
+
+# print the math_variable attribute added_number and list its type
+print(f"math_variable.added_numbers = {math_variable.added_numbers}")
+print(f"type(math_variable.added_numbers) = {type(math_variable.added_numbers)}\n")
+
+# print the math_variable attribute multiplied_numbers and list its type
+print(
+    f"math_variable.multiplied_numbers = "
+    f"{math_variable.multiplied_numbers}"
+    )
+print(
+    f"type(math_variable.multiplied_numbers) = " 
+    f"{type(math_variable.multiplied_numbers)}\n"
+    )
+
+# print the math_variable running a function within the class (add_1_to_both_numbers_and_multiply()) and list its type
+print(
+    f"math_variable.add_1_to_both_numbers_and_multiply() = "
+    f"{math_variable.add_1_to_both_numbers_and_multiply()}"
+    )
+print(
+    f"type(math_variableadd_1_to_both_numbers_and_multiply()) = "
+    f"{type(math_variable.add_1_to_both_numbers_and_multiply())}\n")

examples_to_run/examples.py

@@ -0,0 +1,6 @@
+"""The main math functions from this tutorial"""
+from github_tutorial.main_functions import main_functions
+from github_tutorial.main_functions.main_functions  import math_function_class 
+from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
+
+__version__ = "0.0.0"

github_tutorial/__init__.py

@@ -0,0 +1,3 @@
+"""main math functions"""
+from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
+from github_tutorial.main_functions.main_functions  import math_function_class 

github_tutorial/main_functions/__init__.py

@@ -0,0 +1,90 @@
+import numpy as np
+from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
+from warnings import warn
+
+def _add_1_to_value(initial_value):
+    """Add 1 to to any value.
+
+    This function adds 1 to the entered value. 
+
+    Parameters
+    ----------
+    initial_value: int or float
+        The first integer or float that 1 will be added to.
+    
+    Returns
+    -------
+    final_value: int or float
+        The initial value plus 1.
+    """
+    if not isinstance(initial_value, (int, float)):
+        raise TypeError(
+            f"ERROR: In the '_add_1_to_value' function, the {'initial_value'} "
+            f"is a {type(initial_value)} and not a int or float."
+            )
+
+    if initial_value >= 100:
+        warn(
+            f"WARNING: In the '_add_1_to_value' function, the {'initial_value'} >= 100 "
+            f"({'initial_value'} = {initial_value}). Are you sure you want to use a large number?"   
+            )
+
+
+    final_value = initial_value + 1
+
+    return final_value
+
+# This is the main math Class 
+class math_function_class:
+    """Add 1 to to any value.
+
+        This function adds 1 to the entered value. 
+
+        Parameters
+        ----------
+        initial_value: int or float
+            The first integer or float that 1 will be added to.
+        
+        Returns
+        -------
+        final_value: int or float
+            The initial value plus 1.
+    """
+    def __init__(
+        self,
+        value_0,
+        value_1
+    ):
+        
+        if not isinstance(value_0, (int, float)):
+            raise TypeError(
+                f"ERROR: In the 'math_function_class' class, the {'value_0'} "
+                f"is a {type(value_0)} and not a int or float."
+                )
+        
+        if not isinstance(value_1, (int, float)):
+            raise TypeError(
+                f"ERROR: In the 'math_function_class' class, the {'value_1'} "
+                f"is a {type(value_1)} and not a int or float."
+                )
+
+        self.value_0 = value_0
+        self.value_1 = value_1 
+
+        self.added_numbers = add_2_numbers(self.value_0, self.value_1)
+        self.multiplied_numbers = multiple_of_2_numbers(self.value_0, self.value_1)
+
+    def add_1_to_both_numbers_and_multiply(self):
+        """Add 1 to both value_0 and value_1 and multiply them together.
+
+        This function adds 1 to each of value_0 and value_1 and multiplies them together. 
+
+        Returns
+        -------
+        add_1_to_both_numbers_and_multiply: int or float
+            This function adds 1 to each of value_0 and value_1 and multiplies them together. 
+        """
+        
+        add_1_to_to_each_value_and_mulitipy = _add_1_to_value(self.value_0) * _add_1_to_value(self.value_1)
+
+        return add_1_to_to_each_value_and_mulitipy

github_tutorial/main_functions/main_functions.py

@@ -0,0 +1 @@
+"""test functions for github_tutorial"""

github_tutorial/tests/__init__.py

@@ -0,0 +1,11 @@
+"""test functions for github_tutorial"""
+import pytest
+
+class BaseTest:
+    @pytest.fixture(autouse=True)
+    def initdir(self, tmpdir):
+        tmpdir.chdir()
+
+    @pytest.fixture
+    def get_10_plus_5(self):
+       get_10_plus_5 = 10 + 5 

github_tutorial/tests/base_test.py

@@ -0,0 +1,103 @@
+import numpy as np
+import pytest
+from github_tutorial.tests.base_test import BaseTest
+#from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
+from github_tutorial.main_functions.main_functions  import (math_function_class,  _add_1_to_value)
+
+class TestMainFunction(BaseTest):
+    def test__add_1_to_value_int(self):
+        val_0 = 1
+
+        value = _add_1_to_value(val_0)
+
+        assert value == 2
+        assert isinstance(value, (int, float))
+
+    def test__add_1_to_value_float(self):
+        val_0 = 2.5
+
+        value =  _add_1_to_value(val_0)
+
+        assert np.isclose(value, 3.5)
+        assert isinstance(value, (int, float))
+
+    def test__add_1_to_value_val_0_str(self):
+        with pytest.raises(
+            TypeError,
+            match=f"ERROR: In the '_add_1_to_value' function, the initial_value is a {type('initial_value')} "
+            f"and not a int or float",
+        ):
+            val_0 = '1.5'
+
+            value = _add_1_to_value(val_0)
+    
+    def test__add_1_to_value_val_0_equal_99_99(self):
+        val_0 = 99.999
+
+        value =  _add_1_to_value(val_0)
+
+        assert np.isclose(value, 100.999)
+        assert isinstance(value, (int, float))
+
+    def test__add_1_to_value_val_0_equal_negative_99999_99(self):
+        val_0 = -99999.99
+
+        value =  _add_1_to_value(val_0)
+
+        assert np.isclose(value, -99998.99)
+        assert isinstance(value, (int, float))
+
+    def test__add_1_to_value_val_0_value_greater_equal_100(self):
+        with pytest.warns(
+            UserWarning,
+            match=f"WARNING: In the '_add_1_to_value' function, the {'initial_value'} >= 100 "
+            f"\(initial_value = {101}\). Are you sure you want to use a large number?",
+        ):
+            val_0 = 101
+
+            value = _add_1_to_value(val_0)
+
+    def test__add_1_to_value_val_0_value_greater_equal_100000(self):
+        with pytest.warns(
+            UserWarning,
+            match=f"WARNING: In the '_add_1_to_value' function, the {'initial_value'} >= 100 "
+            f"\(initial_value = {100000}\). Are you sure you want to use a large number?",
+        ):
+            val_0 = 100000
+
+            value = _add_1_to_value(val_0)
+
+    def test_math_function_class(self):
+        val_0 = 1
+        val_1 = 2
+
+        math_variable = math_function_class(val_0, val_1)
+
+        assert np.isclose(math_variable.added_numbers, 3)
+        assert isinstance(math_variable.added_numbers, (int, float))
+        assert np.isclose(math_variable.multiplied_numbers, 2)
+        assert isinstance(math_variable.multiplied_numbers, (int, float))
+        assert np.isclose(math_variable.add_1_to_both_numbers_and_multiply(), 6)
+        assert isinstance(math_variable.add_1_to_both_numbers_and_multiply(), (int, float))
+    
+    def test_math_function_class_val_0_str(self):
+        with pytest.raises(
+            TypeError,
+            match=f"ERROR: In the 'math_function_class' class, the value_0 is a {type('value_0')} "
+            f"and not a int or float",
+        ):
+            val_0 = '1.5'
+            val_1 = 2.0
+
+            math_variable = math_function_class(val_0, val_1)
+
+    def test_math_function_class_val_1_str(self):
+        with pytest.raises(
+            TypeError,
+            match=f"ERROR: In the 'math_function_class' class, the value_1 is a {type('value_1')} "
+            f"and not a int or float",
+        ):
+            val_0 = 1.5
+            val_1 = '2.0'
+
+            math_variable = math_function_class(val_0, val_1)