chtoolbox 0.2.4__tar.gz → 1.0.0__tar.gz

chtoolbox-1.0.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: chtoolbox
+Version: 1.0.0
+Home-page: https://github.com/chagenvik/chtoolbox
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# chtoolbox
+chtoolbox is a library containing various python tools used in my daily work
+
+## Installation
+To install chtoolbox, use pip:
+
+```sh
+pip install chtoolbox
+```
+
+## Usage
+Examples are provided in the `examples` folder in the repository.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

chtoolbox-1.0.0/README.md

@@ -0,0 +1,15 @@
+# chtoolbox
+chtoolbox is a library containing various python tools used in my daily work
+
+## Installation
+To install chtoolbox, use pip:
+
+```sh
+pip install chtoolbox
+```
+
+## Usage
+Examples are provided in the `examples` folder in the repository.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

chtoolbox-1.0.0/chtoolbox/__init__.py

@@ -0,0 +1,26 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from . import misc
+from . import testing
+from .add_license import add_license_to_python_files

chtoolbox-1.0.0/chtoolbox/add_license.py

@@ -0,0 +1,83 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+def add_license_to_python_files(license_file_path='LICENSE', directory='.', gitignore_path='.gitignore'):
+    """
+    Adds the LICENSE text to all Python files in the specified directory where it is not already present.
+    
+    Parameters:
+    - license_file_path (str): Path to the LICENSE file. Default is 'LICENSE'.
+    - directory (str): Directory to search for Python files. Default is '.'.
+    - gitignore_path (str): Path to the .gitignore file. Default is '.gitignore'.
+    """
+    
+    import os
+    import pathspec
+
+    # Check if the LICENSE file exists
+    if not os.path.isfile(license_file_path):
+        raise FileNotFoundError(f"LICENSE file not found at {license_file_path}")
+
+    # Check if the .gitignore file exists
+    if not os.path.isfile(gitignore_path):
+        raise FileNotFoundError(f".gitignore file not found at {gitignore_path}")
+
+    # Read the LICENSE text with UTF-8 encoding
+    with open(license_file_path, 'r', encoding='utf-8') as file:
+        license_text = file.read()
+
+    # Read the .gitignore file
+    with open(gitignore_path, 'r') as file:
+        gitignore = file.read()
+
+    # Create a pathspec from the .gitignore file
+    spec = pathspec.PathSpec.from_lines('gitwildmatch', gitignore.splitlines())
+
+    # Iterate over all files in the directory
+    for root, _, files in os.walk(directory):
+        for file in files:
+            file_path = os.path.join(root, file)
+            
+            # Skip files and directories listed in .gitignore
+            if spec.match_file(file_path):
+                continue
+            
+            if file.endswith('.py'):
+                # Read the original content of the file with UTF-8 encoding
+                with open(file_path, 'r', encoding='utf-8') as original_file:
+                    original_content = original_file.read()
+                
+                # Check if the LICENSE text is already present
+                if license_text not in original_content:
+                    # Prepend the LICENSE text to the original content
+                    new_content = f'"""{license_text}"""\n\n{original_content}'
+                    
+                    # Write the new content back to the file with UTF-8 encoding
+                    with open(file_path, 'w', encoding='utf-8') as modified_file:
+                        modified_file.write(new_content)
+
+    print("LICENSE text added to all Python files where it was not already present.")
+
+
+if __name__ == '__main__':
+    add_license_to_python_files()

{chtoolbox-0.2.4 → chtoolbox-1.0.0}/chtoolbox/misc.py

@@ -1,3 +1,26 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
 import pandas as pd
 
 def clipboard_to_dict(print_dict=True):
@@ -122,37 +145,3 @@ def compare_lists_from_clipboard():
 
     # Print the resulting dictionary
     return list_dict, unique_items, list(common_items)
-
-
-def add_two_numbers(a,b):
-    """
-    Add two numbers together.
-    Args:
-        a (int): The first number.
-        b (int): The second number.
-    Returns:
-        int: The sum of the two numbers.
-    """
-    return a + b
-
-def multiply_two_numbers(a,b):
-    """
-    Multiply two numbers together.
-    Args:
-        a (int): The first number.
-        b (int): The second number.
-    Returns:
-        int: The product of the two numbers.
-    """
-    return a * b
-
-def subtract_two_numbers(a,b):
-    """
-    Subtract two numbers.
-    Args:
-        a (int): The first number.
-        b (int): The second number.
-    Returns:
-        int: The difference between the two numbers.
-    """
-    return a - b

chtoolbox-1.0.0/chtoolbox/testing.py

@@ -0,0 +1,148 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+import pandas as pd
+import itertools
+import numpy as np
+
+def generate_test_results(my_function, cases, print_cases=True):
+    """
+    Generates test results by applying a given function to a set of cases, returning both the input and output.
+    The results dictionary is intended to use as input to tests in the `pytest` framework.
+    
+    Parameters
+    ----------
+    my_function : callable
+        The function to be tested. It should accept keyword arguments.
+    cases : dict or str
+        A dictionary where keys are case names and values are dictionaries of parameters,
+        or a string representing the path to a CSV file containing the cases.
+        The CSV file should have the following format:
+        Example:
+        ```
+        case,a,b,c
+        case1,1,4,7
+        case2,2,5,8
+        case3,3,6,9
+        ```
+
+    print_cases : bool, optional
+        If True, prints the results of each case. Default is True.
+    Returns
+    -------
+    dict
+        A dictionary containing the input parameters and the corresponding output for each case.
+    Raises
+    ------
+    ValueError
+        If `cases` is neither a dictionary nor a path to a CSV file.
+        
+    Examples
+    --------
+    >>> def add(a, b):
+    ...     return {'sum': a + b}
+    >>> cases = {
+    ...     'case1': {'a': 1, 'b': 2},
+    ...     'case2': {'a': 3, 'b': 4}
+    ... }
+    >>> generate_test_data(add, cases)
+    {'case1': {'input': {'a': 1, 'b': 2}, 'output': {'sum': 3}},
+     'case2': {'input': {'a': 3, 'b': 4}, 'output': {'sum': 7}}}
+    """
+
+
+
+    if type(cases) is str and cases[-4:] =='.csv':
+        cases = pd.read_csv(cases, index_col=0)
+        cases = cases.to_dict(orient='index')
+    elif type(cases) is dict:
+        pass
+    else:
+        raise ValueError('Cases must be a dictionary or a csv file')
+
+    results = {key : {'input' : value} for key, value in cases.items()}
+
+    for case_name, params in cases.items():
+        result = my_function(**params)
+
+        results[case_name]['output'] = {}
+
+        if type(result) is dict:
+            for key, val in result.items():
+                results[case_name]['output'][key] = val
+        else:
+            results[case_name]['output'] = result
+
+    if print_cases:
+        # Print the results
+        print('{')
+        for case_name, params in results.items():
+            print(f"'{case_name}': {params},")
+        print('}')
+
+    return results
+
+
+def create_test_cases(inputs, print_cases=True):
+    """
+    Generate test cases from input parameters.
+    Parameters
+    ----------
+    inputs : dict
+        A dictionary where keys are parameter names and values are lists or numpy arrays of parameter values.
+    print_cases : bool, optional
+        If True, print the generated test cases. Default is True.
+    Returns
+    -------
+    dict
+        A dictionary where keys are case names (e.g., 'case1', 'case2', ...) and values are dictionaries of parameter combinations.
+    Examples
+    --------
+    >>> inputs = {
+    ...     'param1': [1, 2],
+    ...     'param2': np.array([3, 4])
+    ... }
+    >>> create_test_cases(inputs)
+    {
+        'case1': {'param1': 1, 'param2': 3},
+        'case2': {'param1': 1, 'param2': 4},
+        'case3': {'param1': 2, 'param2': 3},
+        'case4': {'param1': 2, 'param2': 4}
+    }
+    """
+
+    keys = inputs.keys()
+    values = [v.tolist() if isinstance(v, np.ndarray) else v for v in inputs.values()]
+    combinations = list(itertools.product(*values))
+    df = pd.DataFrame(combinations, columns=keys)
+    df.index = [f'case{i}' for i in range(1, len(df) + 1)]
+
+    cases = df.to_dict(orient='index')
+    
+    if print_cases:
+        print('{')
+        for case_name, params in cases.items():
+            print(f"'{case_name}': {params},")
+        print('}')
+        
+    return cases

chtoolbox-1.0.0/chtoolbox.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: chtoolbox
+Version: 1.0.0
+Home-page: https://github.com/chagenvik/chtoolbox
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# chtoolbox
+chtoolbox is a library containing various python tools used in my daily work
+
+## Installation
+To install chtoolbox, use pip:
+
+```sh
+pip install chtoolbox
+```
+
+## Usage
+Examples are provided in the `examples` folder in the repository.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

{chtoolbox-0.2.4 → chtoolbox-1.0.0}/chtoolbox.egg-info/SOURCES.txt

@@ -2,9 +2,13 @@ LICENSE
 README.md
 setup.py
 chtoolbox/__init__.py
+chtoolbox/add_license.py
 chtoolbox/misc.py
+chtoolbox/testing.py
 chtoolbox.egg-info/PKG-INFO
 chtoolbox.egg-info/SOURCES.txt
 chtoolbox.egg-info/dependency_links.txt
 chtoolbox.egg-info/requires.txt
-chtoolbox.egg-info/top_level.txt
+chtoolbox.egg-info/top_level.txt
+tests/__init__.py
+tests/test_testing.py

chtoolbox-1.0.0/chtoolbox.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy>=1.26.2
+pandas>=2.1.4
+pathspec>=0.12.1

{chtoolbox-0.2.4 → chtoolbox-1.0.0}/chtoolbox.egg-info/top_level.txt

@@ -1 +1,2 @@
 chtoolbox
+tests

chtoolbox-1.0.0/setup.py

@@ -0,0 +1,46 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from setuptools import setup, find_packages
+from pathlib import Path
+
+# Read the requirements from the requirements.txt file
+requirements_path = Path(__file__).parent / 'requirements.txt'
+with requirements_path.open() as requirements_file:
+    requirements = requirements_file.read().splitlines()
+
+# Read the contents of the README file
+readme_path = Path(__file__).parent / 'README.md'
+with readme_path.open() as readme_file:
+    long_description = readme_file.read()
+
+setup(
+    name='chtoolbox',
+    version='1.0.0',
+    packages=find_packages(),
+    install_requires=requirements,
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/chagenvik/chtoolbox'
+)
+

chtoolbox-1.0.0/tests/__init__.py

@@ -0,0 +1,23 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+

chtoolbox-1.0.0/tests/test_testing.py

@@ -0,0 +1,62 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from chtoolbox import testing
+import os
+
+def test_generate_test_results():
+    cases = {'case1': {'a': 1, 'b': 2}, 
+             'case2': {'a': 3, 'b': 4},
+             'case3': {'a': 5, 'b': 6}}
+    
+    def add(a, b):
+        return a+b
+    
+    res = testing.generate_test_results(add, cases)
+
+    for key, value in res.items():
+        assert value['output'] == value['input']['a'] + value['input']['b'] 
+
+def test_generate_test_results_csv():
+    cases = os.path.join(os.path.dirname(__file__), 'data', 'data.csv')
+    
+    f1 = lambda a,b,c: a+b-c
+
+    res1 = testing.generate_test_results(f1, cases)
+
+    for key, value in res1.items():
+        assert value['output'] == value['input']['a'] + value['input']['b'] - value['input']['c']
+
+    def f2(a,b,c):
+        x = {'sum': a+b,
+             'diff': a-b}
+        
+        return x
+    
+    res2 = testing.generate_test_results(f2, cases)
+
+    for key, value in res2.items():
+        assert value['output']['sum'] == value['input']['a'] + value['input']['b']
+        assert value['output']['diff'] == value['input']['a'] - value['input']['b']
+
+

chtoolbox-0.2.4/PKG-INFO

@@ -1,4 +0,0 @@
-Metadata-Version: 2.1
-Name: chtoolbox
-Version: 0.2.4
-License-File: LICENSE

chtoolbox-0.2.4/README.md

@@ -1,2 +0,0 @@
-# chtoolbox
-chtoolbox is a library containing various python tools used in my daily work

chtoolbox-0.2.4/chtoolbox/__init__.py

@@ -1 +0,0 @@
-from . import misc

chtoolbox-0.2.4/chtoolbox.egg-info/PKG-INFO

@@ -1,4 +0,0 @@
-Metadata-Version: 2.1
-Name: chtoolbox
-Version: 0.2.4
-License-File: LICENSE

chtoolbox-0.2.4/chtoolbox.egg-info/requires.txt

@@ -1,2 +0,0 @@
-numpy
-pandas

chtoolbox-0.2.4/setup.py

@@ -1,12 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='chtoolbox',
-    version='0.2.4',
-    packages=find_packages(),
-    install_requires=[
-        'numpy',
-        'pandas',
-    ]
-)
-