lendres 0.1.1__tar.gz

lendres-0.1.1/.github/workflows/build-and-publish.yaml

@@ -0,0 +1,55 @@
+name: build-and-publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+
+  build-windows-python312:
+
+    uses: ./.github/workflows/build-windows-wheel.yaml
+    with:
+      python_version: 3.12
+
+  build-source-dist:
+
+    uses: ./.github/workflows/build-source-dist.yaml
+
+  publish-release:
+
+    needs: [build-source-dist, build-windows-python312]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+
+      - name: Get Wheels
+        uses: actions/download-artifact@v4
+        with:
+          pattern: file-*
+          path: "./dist"
+          merge-multiple: true
+
+      - name: Upload Wheels to Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release upload "${{ github.event.release.tag_name }}" "./dist/"** --repo ${{ github.repository }}
+
+  publish-pypi:
+
+    needs: [build-source-dist, build-windows-python312]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+
+      - name: Get Wheels
+        uses: actions/download-artifact@v4
+        with:
+          pattern: file-*
+          path: "./dist"
+          merge-multiple: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

lendres-0.1.1/.github/workflows/build-source-dist.yaml

@@ -0,0 +1,31 @@
+name: build-source-dist
+
+on:
+  workflow_call
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Update Python
+        run: python -m pip install --upgrade pip build
+
+      - name: Build Source Distribution
+        run: python -m build --sdist --outdir "./dist"
+
+      - name: Store Source Distribution
+        uses: actions/upload-artifact@v4
+        with:
+          name: file-source-dist
+          path: "./dist"

lendres-0.1.1/.github/workflows/build-windows-wheel.yaml

@@ -0,0 +1,36 @@
+name: build-windows-wheel
+
+on:
+  workflow_call:
+    inputs:
+
+      python_version:
+        required: true
+        type: string
+
+jobs:
+
+  build:
+
+    runs-on: windows-latest
+    steps:
+
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ inputs.python_version }}
+
+      - name: Update Python
+        run: python -m pip install --upgrade pip setuptools wheel
+
+      - name: Build Wheel
+        run: python -m pip wheel --no-deps --wheel-dir "./dist" "."
+
+      - name: Store Wheel
+        uses: actions/upload-artifact@v4
+        with:
+          name: file-${{ inputs.python_version }}
+          path: "./dist"

lendres-0.1.1/.gitignore

@@ -0,0 +1,141 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+lendres/plotting/Matplotlib Colors - BASE - Names.png
+lendres/plotting/Matplotlib Colors - CSS - Names.png
+lendres/plotting/Matplotlib Colors - TABLEAU - Names.png
+lendres/plotting/Matplotlib Colors - XKCD - Names.png
+lendres/plotting/Matplotlib Colors - BASE - Hex.png
+lendres/plotting/Matplotlib Colors - CSS - Hex.png
+lendres/plotting/Matplotlib Colors - FULL - Hex.png
+lendres/plotting/Matplotlib Colors - FULL - Names.png
+lendres/plotting/Matplotlib Colors - SEABORN - Hex.png
+lendres/plotting/Matplotlib Colors - SEABORN - Names.png
+lendres/plotting/Matplotlib Colors - TABLEAU - Hex.png
+lendres/plotting/Matplotlib Colors - XKCD - Hex.png

lendres-0.1.1/Examples/Examples.py

@@ -0,0 +1,171 @@
+"""
+Created on July 31, 2022
+@author: Lance A. Endres
+"""
+
+"""
+Miscellaneous Python examples.
+"""
+
+import math
+import os
+import random
+import re
+import sys
+
+
+def CountNumberOfPairs(n, ar):
+    # Get unique values.  Convert to list because set doesn't have a count function.# Get unique values.
+    colors = list(set(ar))
+    print("\nColors:")
+    print(colors)
+
+    # Count the number of times each value appears in the input.
+    counts = [ar.count(i) for i in colors]
+    print("\nCounts")
+    print(counts)
+
+    # Calculate the number of pairs of each type.
+    pairs = [math.floor(i/2.0) for i in counts]
+    print("\nPairs:")
+    print(pairs)
+
+    # Total number of pairs in the input.
+    result = sum(pairs)
+    print("Result:", result)
+    return result
+
+
+def CountingValleys(steps, path):
+    elevation        = 0
+    valleyCount      = 0
+    inValley         = False
+
+    for i in range(steps):
+        # Track our current elevation.
+        if path[i] == "U":
+            elevation += 1
+        else:
+            elevation -= 1
+        print("\nElevation:", elevation)
+
+        # Valleys must be below sea level.
+        # The problem statement is poorly worded (no suprise for HackerRank).
+        # What they intend to mean is a valley is any sequence of steps that
+        # start with a step down from sea level and end with a step up to sea level.
+        # The way the question is worded ("consecutive steps below sea level") could
+        # be interpretued to mean you need multiple steps below sea level.  At which
+        # point you need to define the elevation of a step as a step starts at one
+        # elevation and ends at another.
+        if elevation < 0:
+            inValley = True
+            print("In valley")
+
+        # This catches when we were below sea leven and return to sea level.
+        if elevation == 0 and inValley:
+            valleyCount += 1
+            inValley    = False
+
+    return valleyCount
+
+
+def OrganizingContainers(container):
+    # Sums and sorts rows.
+    r = sorted([sum(x) for x in container])
+
+    # Sums and sorts columns.
+    c = sorted([sum(x) for x in zip(*container)])
+    return "Possible" if r == c else "Impossible"
+    # So in order to explain that, you have to understand the zip() function itself. If zip()
+    # was to be given two or more arrays as arguments, it would create one multi-dimensional
+    # array by grouping up the values of the given arrays by their indices.  When paired with
+    # the zip() function, the "*" operator instead allows you to invert the operation and "unzip"
+    # a multi-dimensional array into the component arrays it would have taken in a hypothetical
+    # initial "zip()" argument. In this case, you break the container down into smaller arrays of
+    # its components that previously shared the same column.  So the R operation line takes the
+    # sums of the rows, and the C operation line takes the sums of the columns.
+
+
+
+def BomberMan(r, c, n, gridString):
+    time      = 1
+    bombTimes = [[0]*c for i in range(r)]
+
+    # Grid string is an array of strings like:
+    # ["xoox", "xxox", "oxxo", "xoxo"]
+    # This converts it to a list of lists (the strings are parsed by each character).
+    grid      = [list(x) for x in gridString]
+
+    printDebug = 0
+    if printDebug:
+        #print("\nInitial grid:", gridString)
+        #print("\nConverted grid:", grid)
+        #print("\nBomb times initial:", bombTimes)
+        print("\nTotal time:", n)
+
+    finalTime = n if n < 4 else 4 + n % 4
+
+    while time < finalTime:
+        # First second do nothing.
+        # Second second plant bombs
+        time += 1
+        if time % 2 == 0:
+            PlantBombs(r, c, n, grid, time, bombTimes, printDebug)
+        else:
+            ExplodeBombs(r, c, n, grid, time, bombTimes, printDebug)
+
+    newGrid = JoinStrings(grid)
+    #if printDebug:
+    #    print("\nNew grid:", newGrid)
+    return newGrid
+
+
+def PlantBombs(r, c, n, grid, time, bombTimes, printDebug):
+    #DisplayGrid("Before planting bombs", grid, printDebug)
+    for i in range(r):
+        for j in range(c):
+            if grid[i][j] == ".":
+                grid[i][j]      = "O"
+                bombTimes[i][j] = time
+
+    #DisplayGrid("After planting bombs", grid, printDebug)
+    #if printDebug:
+    #    print("Times:", bombTimes)
+
+
+def ExplodeBombs(r, c, n, grid, time, bombTimes, printDebug):
+    #DisplayGrid("Before exploding bombs", grid, printDebug)
+    explodeTime = time - 3
+    for i in range(r):
+        for j in range(c):
+            if bombTimes[i][j] == explodeTime:
+                grid[i][j] = "."
+                if i-1 >= 0:
+                    grid[i-1][j] = "."
+                if i+1 < r:
+                    grid[i+1][j] = "."
+                if j-1 >= 0:
+                    grid[i][j-1] = "."
+                if j+1 < c:
+                    grid[i][j+1] = "."
+    #DisplayGrid("After exploding bombs", grid, printDebug)
+
+
+def JoinStrings(grid):
+    return ["".join(string) for string in grid]
+
+
+def DisplayGrid(label, grid, printDebug):
+    if printDebug:
+        print("\n"+label+":")
+        joinedGrid = JoinStrings(grid)
+        print('\n'.join(joinedGrid))
+
+
+def BirthdayCakeCandles(candles):
+    maxValue    = max(candles)
+    numberOfMax = candles.count(maxValue)
+
+    print("Candles:", candles)
+    print("numberOfMax:", numberOfMax)
+    return numberOfMax

lendres-0.1.1/Examples/QuizHelper.py

@@ -0,0 +1,116 @@
+"""
+Created on April 9, 2022
+@author: Lance A. Endres
+"""
+# To help with reading and manipulation of data.
+import numpy                                                    as np
+import pandas                                                   as pd
+
+# To help with data visualization.
+import matplotlib.pyplot                                        as plt
+import seaborn                                                  as sns
+
+
+from lendres.plotting.PlotHelper                                import PlotHelper
+from lendres.plotting.AxesHelper                                import AxesHelper
+
+# To get different performance metrics.
+import sklearn.metrics                                          as metrics
+from sklearn.metrics import (
+    classification_report,
+    confusion_matrix,
+    recall_score,
+    accuracy_score,
+    precision_score,
+    f1_score
+)
+
+
+# defining a function to compute different metrics to check performance of a classification model built using sklearn
+def model_performance_classification_sklearn(model, predictors, target):
+    """
+    Function to compute different metrics to check classification model performance
+
+    model: classifier
+    predictors: independent variables
+    target: dependent variable
+    """
+
+    # predicting using the independent variables
+    pred = model.predict(predictors)
+
+    accuracy     = accuracy_score(target, pred)
+    recall       = recall_score(target, pred)
+    precision    = precision_score(target, pred)
+    f1           = f1_score(target, pred)
+
+    # creating a dataframe of metrics
+    df_perf = pd.DataFrame(
+        {
+            "Accuracy"  : accuracy,
+            "Recall"    : recall,
+            "Precision" : precision,
+            "F1"        : f1,
+        },
+        index=[0],
+    )
+
+    return df_perf
+
+
+def model_performance_classification(trueValues, predictedValues):
+    """
+    Function to compute different metrics to check classification model performance.  Uses
+    the true (specified) and predicted values as input.
+
+    trueValues: independent variable true values
+    predictedValues: independent variable predicted values
+    """
+    accuracy     = accuracy_score(trueValues, predictedValues)
+    recall       = recall_score(trueValues, predictedValues)
+    precision    = precision_score(trueValues, predictedValues)
+    f1           = f1_score(trueValues, predictedValues)
+
+    # creating a dataframe of metrics
+    performanceDataFrame = pd.DataFrame(
+        {
+            "Accuracy"  : accuracy,
+            "Recall"    : recall,
+            "Precision" : precision,
+            "F1"        : f1,
+        },
+        index=[0],
+    )
+
+    return performanceDataFrame
+
+
+def confusion_matrix_sklearn(model, predictors, target, titleSuffix=None):
+    """
+    To plot the confusion_matrix with percentages
+
+    model: classifier
+    predictors: independent variables
+    target: dependent variable
+    """
+    y_pred = model.predict(predictors)
+    cm     = confusion_matrix(target, y_pred)
+
+    labels = np.asarray(
+        [
+            ["{0:0.0f}".format(item) + "\n{0:.2%}".format(item / cm.flatten().sum())]
+            for item in cm.flatten()
+        ]
+    ).astype("object").reshape(2, 2)
+
+    # Tack on the type labels to the numerical information.
+    labels[0, 0] += "\nTN"
+    labels[1, 0] += "\nFN\nType 2"
+    labels[0, 1] += "\nFP\nType 1"
+    labels[1, 1] += "\nTP"
+
+    PlotHelper.Format(width=5.35, height=4)
+    #plt.figure(figsize=(6, 4))
+    axis = sns.heatmap(cm, annot=labels, annot_kws={"fontsize" : 14*PlotHelper.formatSettings.Scale}, fmt="")
+    AxesHelper.Label(axis, title="Data", xLabels="Predicted", yLabel="Actual", titleSuffix=titleSuffix)
+    plt.show()

lendres-0.1.1/Examples/psd.py

@@ -0,0 +1,49 @@
+"""
+Created on March 23, 2024
+@author: Lance Endres
+"""
+import numpy as np
+from matplotlib import pyplot as plt
+from scipy import signal
+
+np.random.seed(0)
+
+time_step = .01
+time_vec = np.arange(0, 70, time_step)
+
+# A signal with a small frequency chirp
+vals = 0.5 * np.pi * time_vec * (1 + .1 * time_vec)
+print("Values Type:", type(vals))
+print("Values Length:", len(vals))
+print("Values Shape:", vals.shape)
+
+sig = np.sin(vals)
+
+print("Signal Type:", type(sig))
+print("Signal Length:", len(sig))
+print("Signal Shape:", sig.shape)
+
+plt.figure(figsize=(8, 5))
+plt.plot(time_vec, sig)
+
+
+
+freqs, times, spectrogram = signal.spectrogram(sig, fs=1.0/time_step)
+
+plt.figure(figsize=(5, 4))
+plt.imshow(spectrogram, aspect='auto', cmap='hot_r', origin='lower')
+plt.title('Spectrogram')
+plt.ylabel('Frequency band')
+plt.xlabel('Time window')
+plt.tight_layout()
+
+
+
+freqs, psd = signal.welch(sig)
+
+plt.figure(figsize=(5, 4))
+plt.semilogx(freqs, psd)
+plt.title('PSD: power spectral density')
+plt.xlabel('Frequency')
+plt.ylabel('Power')
+plt.tight_layout()

lendres-0.1.1/Installation.txt

@@ -0,0 +1,14 @@
+WINDOWS MACHINES
+
+Add the environmental variable:
+PYTHONPATH
+C:\Custom Program Files\Python
+
+
+VISUAL STUDIO CODE
+
+To prevent "importing the numpy c-extensions failed":
+- Open VS Code's Command Palette menu by pressing Ctrl+Shift+P or F1
+- Choose "Terminal: Select Default Profile"
+- Then pick "Command Prompt" option
+- Restart VS Code

lendres-0.1.1/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021-2024 Lance A. Endres
+
+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.

lendres-0.1.1/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: lendres
+Version: 0.1.1
+Summary: A collection of general Python utilities from Lance A. Endres.
+License: Copyright (c) 2021-2024 Lance A. Endres
+        
+        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.
+        
+Project-URL: homepage, https://github.com/lendres/Python
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+Requires-Dist: adjustText==1.2.0
+Requires-Dist: beautifulsoup4==4.12.3
+Requires-Dist: contractions==0.1.73
+Requires-Dist: ipython==8.12.3
+Requires-Dist: matplotlib==3.9.0
+Requires-Dist: nltk==3.8.1
+Requires-Dist: numpy==1.26.4
+Requires-Dist: pandas==2.2.2
+Requires-Dist: Pillow==10.4.0
+Requires-Dist: scikit_learn==1.5.1
+Requires-Dist: scipy==1.13.1
+Requires-Dist: seaborn==0.13.2
+Requires-Dist: spacy==3.7.5
+Requires-Dist: wordcloud==1.9.3
+
+# Python Library
+A collection of general Python utilities from Lance A. Endres.

lendres-0.1.1/README.md

@@ -0,0 +1,2 @@
+# Python Library
+A collection of general Python utilities from Lance A. Endres.