Initial commit

Author: rambasnet

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+extend-ignore = E203
+exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
+max-complexity = 10

.githooks/pre-commit

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+#current_branch=$(git symbolic-ref --short head)
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+echo "Running pre-commit hook on branch: $current_branch"
+if [[ "$current_branch" == "main" ]]; then
+    echo "Commit on main is not allowed. Please use a feature branch."
+    exit 1
+fi
+
+valid_branch_regex="^(lab|project|assignment|homework|issue|dev|feature|bugfix|improvement|library|prerelease|release|hotfix)\/.+$"
+
+message="ERROR on Commit. Branch name must adhere to this contract: $valid_branch_regex. Rename your branch to a valid name and try again."
+
+if [[ ! $current_branch =~ $valid_branch_regex ]]
+then
+    echo "$message"
+    echo "git branch -m <branch/sub-branch>"
+    exit 1
+fi
+
+exit 0

.githooks/pre-push

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+#current_branch=$(git symbolic-ref --short head)
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+if [[ $current_branch != "main" ]]; then
+  exit 0
+fi
+echo "Running pre-push hook on $current_branch branch"
+make all
+# $? stores exit value of the last command
+if [[ $? != 0 ]]; then
+ echo "Tests must pass before push to main!"
+ exit 1
+fi
+
+exit 0

.github/workflows/ci-test.yml

@@ -0,0 +1,53 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: GitHub Actions CI/CD
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+          # can install packages from a requirements file
+          if [ -f ci-cd-requirements.txt ]; then pip install -r ci-cd-requirements.txt; fi
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 --count --show-source --statistics demo-assignments/A0/hello
+          flake8 --count --show-source --statistics demo-assignments/A0-OOP/hello
+          flake8 --count --show-source --statistics demo-assignments/A1/cold
+          flake8 --count --show-source --statistics demo-assignments/A1-OOP/cold
+          flake8 --count --show-source --statistics demo-assignments/A2-ABC/egypt
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Check types with mypy
+        run: |
+          mypy --strict --allow-untyped-decorators --ignore-missing-imports demo-assignments/A0/hello 
+          mypy --strict --allow-untyped-decorators --ignore-missing-imports demo-assignments/A0-OOP/hello 
+          mypy --strict --allow-untyped-decorators --ignore-missing-imports demo-assignments/A1/cold
+          mypy --strict --allow-untyped-decorators --ignore-missing-imports demo-assignments/A1-OOP/cold
+          mypy --strict --allow-untyped-decorators --ignore-missing-imports demo-assignments/A2-ABC/egypt
+      - name: Test with pytest
+        run: |
+          pytest --verbose demo-assignments/A0/hello/tests
+          pytest --verbose demo-assignments/A0-OOP/hello/tests
+          pytest --verbose demo-assignments/A1/cold/tests
+          pytest --verbose demo-assignments/A1-OOP/cold/tests
+          pytest --verbose demo-assignments/A2-ABC/egypt/tests

.gitignore

@@ -0,0 +1,130 @@
+# 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:
+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/
+.DS_Store
+htmlcov/

.mypy.ini

@@ -0,0 +1,22 @@
+[mypy]
+exclude = (?x)(
+    kattis-cli # file/folder that starts with kattis-cli
+    | \.github  # file/folder that starts with .github
+    | \.githooks   # file/folder that starts with .githooks
+    | tests  # file/folder that starts with tests
+  )
+disallow_any_generics = false
+disallow_incomplete_defs = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = false
+disallow_untyped_defs = true
+follow_imports = normal
+ignore_missing_imports = true
+no_implicit_reexport = true
+show_error_codes = true
+show_error_context = true
+strict_equality = true
+strict_optional = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_ignores = true

Dockerfile

@@ -0,0 +1,43 @@
+FROM python:3.10
+
+RUN apt update \
+  && apt install -y \
+  g++ gcc make sqlite3 time curl git nano dos2unix \
+  net-tools iputils-ping iproute2 sudo gdb less \
+  && apt clean;
+
+# Install Java and Graphviz for plantuml
+RUN apt install default-jre graphviz -y
+
+ARG USER=user
+ARG UID=1000
+ARG GID=1000
+
+# Set environment variables
+ENV USER                ${USER}
+ENV HOME                /home/${USER}
+
+# Create user and setup permissions on /etc/sudoers
+RUN useradd -m -s /bin/bash -N -u $UID $USER && \
+  echo "${USER} ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers && \
+  chmod 0440 /etc/sudoers && \
+  chmod g+w /etc/passwd 
+
+WORKDIR ${HOME}
+
+RUN pip install --upgrade pip
+
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Install zsh - use "Bira" theme with some customization. 
+RUN sh -c "$(wget -O- https://github.com/deluan/zsh-in-docker/releases/download/v1.1.5/zsh-in-docker.sh)" -- \
+  -t bira \
+  -p git \
+  -p ssh-agent \
+  -p https://github.com/zsh-users/zsh-autosuggestions \
+  -p https://github.com/zsh-users/zsh-completions
+
+USER user
+
+CMD zsh

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ram Basnet
+
+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.

Makefile

@@ -0,0 +1,52 @@
+TEST = pytest
+TEST_ARGS = -s --verbose --color=yes
+TYPE_CHECK = mypy --strict --allow-untyped-decorators --ignore-missing-imports
+STYLE_CHECK = flake8
+COVERAGE = python -m pytest
+DEMO = './demo-assignments'
+
+.PHONY: all
+all: check-style check-type run-test-coverage clean
+	@echo "All checks passed!"
+
+.PHONY: check-type
+check-type:
+	$(TYPE_CHECK) $(DEMO)/A0/hello
+	$(TYPE_CHECK) $(DEMO)/A0-OOP/hello
+	$(TYPE_CHECK) $(DEMO)/A1/cold
+	$(TYPE_CHECK) $(DEMO)/A1-OOP/cold
+	$(TYPE_CHECK) $(DEMO)/A2-ABC/egypt
+
+.PHONY: check-style
+check-style:
+	$(STYLE_CHECK) $(DEMO)/A0/hello
+	$(STYLE_CHECK) $(DEMO)/A0-OOP/hello
+	$(STYLE_CHECK) $(DEMO)/A1/cold
+	$(STYLE_CHECK) $(DEMO)/A1-OOP/cold
+	$(STYLE_CHECK) $(DEMO)/A2-ABC/egypt
+
+# discover and run all tests
+.PHONY: run-test
+run-test:
+	$(TEST) $(TEST_ARGS) $(DEMO)/A0/hello/tests
+	$(TEST) $(TEST_ARGS) $(DEMO)/A0-OOP/hello/tests
+	$(TEST) $(TEST_ARGS) $(DEMO)/A1/cold/tests
+	$(TEST) $(TEST_ARGS) $(DEMO)/A1-OOP/cold/tests
+	$(TEST) $(TEST_ARGS) $(DEMO)/A2-ABC/egypt/tests
+
+.PHONY: run-test-coverage
+run-test-coverage:
+	$(COVERAGE) -v --cov-report=html:$(DEMO)/A0/hello/htmlcov --cov-report=term --cov=$(DEMO)/A0/hello $(DEMO)/A0/hello/tests
+	$(COVERAGE) -v --cov-report=html:$(DEMO)/A0-OOP/hello/htmlcov --cov-report=term --cov=$(DEMO)/A0-OOP/hello $(DEMO)/A0-OOP/hello/tests
+	$(COVERAGE) -v --cov-report=html:$(DEMO)/A1/cold/htmlcov --cov-report=term --cov=$(DEMO)/A1/cold $(DEMO)/A1/cold/tests
+	$(COVERAGE) -v --cov-report=html:$(DEMO)/A1-OOP/cold/htmlcov --cov-report=term --cov=$(DEMO)/A1-OOP/cold $(DEMO)/A1-OOP/cold/tests
+	$(COVERAGE) -v --cov-report=html:$(DEMO)/A2-ABC/egypt/htmlcov --cov-report=term --cov=$(DEMO)/A2-ABC/egypt $(DEMO)/A2-ABC/egypt/tests
+
+.PHONY: clean
+clean:
+	# remove all caches recursively
+	rm -rf `find . -type d -name __pycache__` # remove all pycache
+	rm -rf `find . -type d -name .pytest_cache` # remove all pytest cache
+	rm -rf `find . -type d -name .mypy_cache` # remove all mypy cache
+	rm -rf `find . -type d -name .hypothesis` # remove all hypothesis cache
+	rm -rf `find . -name .coverage` # remove all coverage cache