Merge pull request #1 from TruCol/run-instructions-ubuntu

Run instructions ubuntu

.markdownlint.yaml

@@ -0,0 +1,13 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013:
+  line_length: 80
+  tables: false
+  headings: false
+
+# MD033/no-inline-html - Inline HTML
+MD033:
+  # Allowed elements
+  allowed_elements: [br,img]

.pre-commit-config.yaml

@@ -0,0 +1,204 @@
+# This file specifies which checks are performed by the pre-commit service.
+# The pre-commit service prevents people from pushing code to git that is not
+# up to standards. # The reason mirrors are used instead of the actual
+# repositories for e.g. black and flake8, is because those repositories also
+# need to contain a pre-commit hook file, which they often don't by default.
+# So to resolve that, a mirror is created that includes such a file.
+
+repos:
+# Test if the python code is formatted according to the Black standard.
+ - repo: https://github.com/Quantco/pre-commit-mirrors-black
+   rev: 24.3.0
+   hooks:
+     - id: black-conda
+       args:
+         - --safe
+         - --target-version=py36
+
+# Test if the python code is formatted according to the flake8 standard.
+ - repo: https://github.com/Quantco/pre-commit-mirrors-flake8
+   rev: 7.0.0
+   hooks:
+    - id: flake8-conda
+
+# Test if the import statements are sorted correctly.
+ - repo: https://github.com/PyCQA/isort
+   rev: 5.13.2
+   hooks:
+    - id: isort
+      args: ["--profile", "black", --line-length=79]
+
+# Test if the variable typing is correct. (Variable typing is when you say:
+# def is_larger(nr: int) -> bool: instead of def is_larger(nr). It makes
+# it explicit what type of input and output a function has.
+# - repo: https://github.com/python/mypy
+ - repo: https://github.com/pre-commit/mirrors-mypy
+### - repo: https://github.com/a-t-0/mypy
+   rev: v1.9.0
+   hooks:
+    - id: mypy
+      # args: ["--disallow-untyped-calls", "--disallow-untyped-defs"]
+      args: ["--strict"]
+      additional_dependencies:
+            - typeguard
+
+  # TODO:
+  #--strict
+  #--disallow-incomplete-defs
+  #--disallow-any-unimported
+  #--disallow-any-expr
+  #--disallow-any-decorated
+  #--disallow-any-explicit
+  #--disallow-any-generics
+  #--disallow-subclassing-any
+
+# Tests if there are spelling errors in the code.
+ - repo: https://github.com/codespell-project/codespell
+   rev: v2.2.6
+   hooks:
+    - id: codespell
+
+# Performs static code analysis to check for programming errors.
+ - repo: local
+   hooks:
+     - id: pylint
+       name: pylint
+       entry: pylint
+       language: system
+       types: [python]
+       args:
+         [
+           "-rn", # Only display messages
+           "-sn", # Don't display the score
+         ]
+
+# Runs additional tests that are created by the pre-commit software itself.
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+   rev: v4.5.0
+   hooks:
+    # Check user did not add large files.
+    #- id: check-added-large-files
+    # Check if `.py` files are written in valid Python syntax.
+    - id: check-ast
+    # Require literal syntax when initializing empty or zero Python builtin types.
+    - id: check-builtin-literals
+    # Checks if there are filenames that would conflict if case is changed.
+    - id: check-case-conflict
+    # Checks if the Python functions have docstrings.
+    - id: check-docstring-first
+    # Checks if any `.sh` files have a shebang like #!/bin/bash
+    - id: check-executables-have-shebangs
+    # Verifies json format of any `.json` files in repo.
+    - id: check-json
+    # Checks if there are any existing merge conflicts caused by the commit.
+    - id: check-merge-conflict
+    # Checks for symlinks which do not point to anything.
+    - id: check-symlinks
+    # Checks if xml files are formatted correctly.
+    - id: check-xml
+    # Checks if .yml files are valid.
+    - id: check-yaml
+    # Checks if debugger imports are performed.
+    - id: debug-statements
+    # Detects symlinks changed to regular files with content path symlink was pointing to.
+    - id: destroyed-symlinks
+    # Checks if you don't accidentally push a private key.
+    - id: detect-private-key
+    # Replaces double quoted strings with single quoted strings.
+    # This is not compatible with Python Black.
+    #- id: double-quote-string-fixer
+    # Makes sure files end in a newline and only a newline.
+    - id: end-of-file-fixer
+    # Removes UTF-8 byte order marker.
+    - id: fix-byte-order-marker
+    # Add <# -*- coding: utf-8 -*-> to the top of python files.
+    #- id: fix-encoding-pragma
+    # Checks if there are different line endings, like \n and crlf.
+    - id: mixed-line-ending
+    # Asserts `.py` files in folder `/test/` (by default:) end in `_test.py`.
+    - id: name-tests-test
+      # Override default to check if `.py` files in `/test/` START with `test_`.
+      args: ['--django']
+    # Ensures JSON files are properly formatted.
+    - id: pretty-format-json
+      args: ['--autofix']
+    # Sorts entries in requirements.txt and removes incorrect pkg-resources entries.
+    - id: requirements-txt-fixer
+    # Sorts simple YAML files which consist only of top-level keys.
+    - id: sort-simple-yaml
+    # Removes trailing whitespaces at end of lines of .. files.
+    - id: trailing-whitespace
+
+
+
+
+
+ - repo: https://github.com/PyCQA/autoflake
+   rev: v2.3.1
+   hooks:
+    - id: autoflake
+      args: ["--in-place", "--remove-unused-variables", "--remove-all-unused-imports", "--recursive"]
+      name: AutoFlake
+      description: "Format with AutoFlake"
+      stages: [commit]
+
+ - repo: https://github.com/PyCQA/bandit
+   rev: 1.7.8
+   hooks:
+   - id: bandit
+     name: Bandit
+     stages: [commit]
+
+# Enforces formatting style in Markdown (.md) files.
+ - repo: https://github.com/executablebooks/mdformat
+   rev: 0.7.17
+   hooks:
+   - id: mdformat
+     #args: ["-r ~MD013"]
+     additional_dependencies:
+     - mdformat-toc
+     - mdformat-gfm
+     - mdformat-black
+
+ #- repo: https://github.com/MarcoGorelli/absolufy-imports
+ #  rev: v0.3.1
+ #  hooks:
+ #  - id: absolufy-imports
+ #    files: '^src/.+\.py$'
+ #    args: ['--never', '--application-directories', 'src']
+
+ - repo: https://github.com/myint/docformatter
+   rev: v1.7.5
+   hooks:
+   - id: docformatter
+
+ - repo: https://github.com/pre-commit/pygrep-hooks
+   rev: v1.10.0
+   hooks:
+   - id: python-use-type-annotations
+   - id: python-check-blanket-noqa
+   - id: python-check-blanket-type-ignore
+
+# Updates the syntax of `.py` files to the specified python version.
+# It is not compatible with: pre-commit hook: fix-encoding-pragma
+ - repo: https://github.com/asottile/pyupgrade
+   rev: v3.15.2
+   hooks:
+     - id: pyupgrade
+       args: [--py38-plus]
+
+
+ - repo: https://github.com/igorshubovych/markdownlint-cli
+   rev: v0.32.2
+   hooks:
+     - id: markdownlint
+       args: ["--fix"]
+
+
+ - repo: https://github.com/pre-commit/mirrors-prettier
+   rev: "v4.0.0-alpha.8"
+   hooks:
+     - id: prettier
+       additional_dependencies: ["prettier@2.7.1", "prettier-plugin-solidity@1.0.0"]
+       files: "\\.sol$"
+       args: ["--plugin=prettier-plugin-solidity"]

.solhint.json

@@ -1,11 +1,25 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "code-complexity": ["error", 8],
-    "compiler-version": ["error", ">=0.8.23"],
+    "code-complexity": [
+      "error",
+      8
+    ],
+    "compiler-version": [
+      "error",
+      ">=0.8.23"
+    ],
     "func-name-mixedcase": "off",
-    "func-visibility": ["error", { "ignoreConstructors": true }],
-    "max-line-length": ["error", 120],
+    "func-visibility": [
+      "error",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "max-line-length": [
+      "error",
+      120
+    ],
     "named-parameters-mapping": "warn",
     "no-console": "off",
     "not-rely-on-time": "off",

LICENSE.md

@@ -1,16 +1,22 @@
-MIT License
+# MIT License
 
 Copyright (c) 2024 Paul Razvan Berg
 
-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:
+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 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.
+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.