Merge branch 'master' into fix/local-checkfile

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows]
+ - Browser [e.g. Google, Firefox]
+ - Version [e.g. Windows 11]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build.yml

@@ -4,6 +4,7 @@ name: build
 # Use more columns for terminal output
 env:
   COLUMNS: 120
+  PYTHONIOENCODING: utf8
 
 # Controls when the action will run
 # Workflow begins with push or PR events
@@ -18,12 +19,18 @@ on:
 # This job performs all necessary checks
 jobs:
   build:
-    # Use the latest version of Ubuntu on Microsoft Azure
-    runs-on: ubuntu-latest
+    # Use the latest version of Ubuntu on MacOS and Windows
+    runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        # Performs all actions on different versions of Python
-        python-version: ['3.11']
+        os: [ubuntu-latest]
+        python-version: ["3.11"]
+        include:
+          - os: macos-latest
+            python-version: "3.11"
+          - os: windows-latest
+            python-version: "3.11"
     # Define the workflow steps
     steps:
     # Checkout the code of the repository
@@ -34,6 +41,7 @@ jobs:
         # Run the mdl linting tool
         # Refers to .mdlrc file in repository
         - name: Run Markdown Linting
+          if: matrix.os == 'ubuntu-latest'
           uses: actionshub/markdownlint@main
         # Setup Python for the current language version
         - name: Setup Python ${{ matrix.python-version }}
@@ -62,11 +70,12 @@ jobs:
           if: always()
           run: |
             poetry run task lint
-        # Run the program
+          # Run the program
         - name: Run program
           if: always()
           run: |
-           poetry run chasten analyze chasten --config $PWD/.chasten/ --debug-level ERROR --debug-dest CONSOLE --search-path .
+            poetry run chasten analyze chasten --config $PWD/.chasten/ --debug-level ERROR --debug-dest CONSOLE --search-path .
+
         # Run the tests
         - name: Run Tests
           if: always()
@@ -79,7 +88,7 @@ jobs:
             poetry run task test-coverage-silent > coverage.txt
         # Display the Coverage Report
         - name: Display Coverage
-          if: always()
+          if: always() && matrix.os == 'ubuntu-latest'
           run: |
             export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
             echo "total=$TOTAL" >> $GITHUB_ENV
@@ -98,4 +107,4 @@ jobs:
             message: ${{ env.total }}%
             minColorRange: 50
             maxColorRange: 90
-            valColorRange: ${{ env.total }}
+            valColorRange: ${{ env.total }}

.gitignore

@@ -366,3 +366,6 @@ coverage.txt
 
 # coverage report
 coverage.json
+
+# bash command history
+.bash_history

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Welcome to the Chasten Contributing Guide
+
+In this guide you will get an overview of how you can contribute to this project.
+
+When contributing to this repository, please first discuss the changes you wish to make via an issue and/or pull request with the owners of this repository.
+
+Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+To get an overview of the project, read the [README](README.md).
+
+## Issues
+
+If you find a problem with our program, scan through our [existing issues](https://github.com/AstuteSource/chasten/issues) first to see if we are already aware of and working on the issue. If it is an issue that hasn't been addressed before, you can open a new issue using our [bug report issue template](.github/ISSUE_TEMPLATE/bug_report.md).
+
+Even if you have not found a problem you are still welcome to contribute. Look through our [existing issues](https://github.com/AstuteSource/chasten/issues) and find something that you would like to work on!
+
+Have a feature you think should be implemented? Use our [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) to let us know!
+
+### Creating a New Issue
+
+Use our [bug report issue template](.github/ISSUE_TEMPLATE/bug_report.md) when creating a new issue. Be as clear as possible about what exactly the problem is. Explain how you came to encounter this error. Include any relevent code segment, screen shots, error messages, etc. People will not be able to effectivly help solve the problem without all of the information. Learn about creating issues [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue).
+
+### Existing Issues
+
+If the issue already exists, share any helpful information that you have gained with the other people working on the issue. Be sure to read over the previous disscusions, as to provide your best possible contributions. Any new information could bring us one step closer to solving an issue!
+
+## Making Changes
+
+Any changes being made to our program must first be done in a branch or fork. Once you (and your fellow contributors) are done making changes, you may create a pull request (PR) to the [main repository](https://github.com/AstuteSource/chasten).
+
+### Branches
+
+Branches are one of the possible features of GitHub that you could use to make changes to our project. Learn about branches [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches).
+
+### Forks
+
+Another feature of GitHub that you could use to make changes to our project are forks. Learn about forks [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks).
+
+### Pull Requests
+
+Once all your changes are made and you are confident it works, you can create a pull request using our [pull request template](pull_request_template.md). Please include proof of success on all three operating systems (Windows, MacOS, and Linux). A commitee of reviewers will look over the contents of the PR to ensure the accuracy of the changes and that you adhered to our standards.
+
+Learn about pull requests [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).

Dockerfile

@@ -0,0 +1,33 @@
+FROM ubuntu
+
+RUN apt-get update -y \
+    && apt-get upgrade -y \
+    && apt-get install software-properties-common -y \
+    && add-apt-repository ppa:deadsnakes/ppa -y \
+    && DEBIAN_FRONTEND=noninteractive apt-get install python3.11 -y \
+    && update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.10 1 \
+    && update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 2 \
+    && apt-get install python-is-python3 -y
+
+RUN apt-get install -y curl \
+    && curl -sSL https://install.python-poetry.org | python - \
+    && apt install -y python3.11 python3.11-distutils \
+    && curl -sSl https://bootstrap.pypa.io/get-pip.py | python -
+
+RUN apt-get install -y libsqlite3-dev \
+    && apt-get install python3.11-dev -y \
+    && apt-get install -y libgmp-dev \
+        portaudio19-dev \
+        libssl-dev \
+        libpcap-dev \
+        libffi-dev \
+        libxml2-dev \
+        libxslt1-dev \
+        libblas-dev \
+        libatlas-base-dev \
+    && apt-get install -y gcc-x86-64-linux-gnu
+
+CMD cd root \
+    && mkdir src
+
+ENTRYPOINT export PATH="/root/.local/bin:$PATH" && cd root/src && /bin/bash