.github/workflows/ci.yaml

@@ -1,23 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  test-and-check:
-    name: Tests and checks
-    uses: daniil-berg/reusable-workflows/.github/workflows/python-test.yaml@v0.0.1
-    with:
-      versions: '["3.9", "3.10", "3.11"]'
-      cache: pip
-      cache-dependency-path: pyproject.toml
-      unittest-command: 'scripts/test.sh'
-      coverage-command: 'scripts/cov.sh'
-      unittest-requirements: "-e '.[dev]'"
-      typecheck-command: 'scripts/typecheck.sh'
-      typecheck-requirements: '-U mypy'
-      typecheck-all-versions: true
-      lint-command: 'scripts/lint.sh'
-      lint-requirements: '-Ur requirements/dev.txt'

pyproject.toml

@@ -20,7 +20,7 @@ keywords = [
 ]
 license = { text = "Apache Software License Version 2.0" }
 classifiers = [
-    "Development Status :: 5 - Production/Stable",
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -52,14 +52,14 @@ dev = [
 ]
 
 [project.urls]
-"Repository" = "https://github.com/daniil-berg/marshmallow-generic"
+repository = "https://github.com/daniil-berg/marshmallow-generic"
-"Issue Tracker" = "https://github.com/daniil-berg/marshmallow-generic/issues"
+bug_tracker = "https://github.com/daniil-berg/marshmallow-generic/issues"
-"Documentation" = "http://daniil-berg.github.io/marshmallow-generic"
+documentation = "http://daniil-berg.github.io/marshmallow-generic"
 
 [tool.setuptools.dynamic]
 dependencies = { file = "requirements/common.txt" }
-readme = { file = ["README.md"], content-type = "text/markdown" }
+readme = { file = ["README.md"] }
-version = { attr = "marshmallow_generic.__version__" }
+version = {attr = "marshmallow_generic.__version__"}
 
 #########################
 # Static type checking: #

scripts/ci.sh

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-# Runs full CI pipeline (test, typecheck, lint).
-
-typeset scripts_dir="$(dirname $(realpath $0))"
-
-source "${scripts_dir}/util.sh"
-
-"${scripts_dir}/test.sh"
-"${scripts_dir}/typecheck.sh"
-"${scripts_dir}/lint.sh"
-
-echo -e "${background_black}${bold_green}✅ 🎉 All checks passed!${color_reset}"

scripts/cov.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-# Runs unit tests.
-# If successful, prints only the coverage percentage.
-# If an error occurs, prints the entire unit tests progress output.
-
-source "$(dirname $(realpath $0))/util.sh"
-
-coverage erase
-run_and_capture coverage run
-coverage report | awk '$1 == "TOTAL" {print $NF; exit}'

scripts/lint.sh

@@ -1,17 +1,18 @@
 #!/usr/bin/env bash
-# Runs various linters.
+# Runs type checker and linters.
 
-source "$(dirname $(realpath $0))/util.sh"
+# Ensure that we return to the current working directory
+# and exit the script immediately in case of an error:
+trap "cd $(realpath ${PWD}); exit 1" ERR
+# Change into project root directory:
+cd "$(dirname $(dirname $(realpath $0)))"
+
+echo 'Performing type checks...'
+mypy
+echo
 
 echo 'Linting source and test files...'
-
-echo '  isort - consistent imports'
 isort src/ tests/ --check-only
-
-echo '  ruff - extensive linting'
 ruff src/ tests/
-
+black src/ tests/ --check
-echo '  black - consistent style'
+echo -e 'No issues found.'
-run_and_capture black src/ tests/ --check
-
-echo -e "${bold_green}No issues found${color_reset}\n"

scripts/test.sh

@@ -1,12 +1,17 @@
 #!/usr/bin/env bash
-# Runs unit tests and reports coverage percentage.
+# Runs unit tests and prints only coverage percentage, if successful.
+# If an error occurs, prints the entire unit tests progress output.
 
-source "$(dirname $(realpath $0))/util.sh"
+# Ensure that we return to the current working directory in case of an error:
+trap "cd $(realpath ${PWD})" ERR
+# Change into project root directory:
+cd "$(dirname $(dirname $(realpath $0)))"
 
-echo 'Running unit tests...'
+coverage erase
-coverage run
+# Capture the test progression in a variable:
-typeset percentage
+typeset progress
-typeset color
+progress=$(coverage run 2>&1)
-percentage="$(coverage report | awk '$1 == "TOTAL" {print $NF; exit}')"
+# If tests failed or produced errors, write progress/messages to stderr and exit:
-[[ $percentage == "100%" ]] && color="${bold_green}" || color="${yellow}"
+[[ $? -eq 0 ]] || { >&2 echo "${progress}"; exit 1; }
-echo -e "${color}${percentage} coverage${color_reset}\n"
+# Otherwise extract the total coverage percentage from the produced report and write it to stdout:
+coverage report | awk '$1 == "TOTAL" {print $NF; exit}'

scripts/typecheck.sh

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-# Runs type checker.
-
-source "$(dirname $(realpath $0))/util.sh"
-
-echo 'Performing type checks...'
-mypy
-echo

scripts/util.sh

@@ -1,20 +0,0 @@
-run_and_capture() {
-  # Captures stderr of any command passed to it
-  # and releases it only if the command exits with a non-zero code.
-  typeset output
-  output=$($@ 2>&1)
-  typeset exit_status=$?
-  [[ $exit_status == 0 ]] || >&2 echo "${output}"
-  return $exit_status
-}
-
-# Ensure that we return to the current working directory
-# and exit the script immediately in case of an error:
-trap "cd $(realpath ${PWD}); exit 1" ERR
-# Change into project root directory:
-cd "$(dirname $(dirname $(realpath $0)))"
-
-typeset background_black='\033[40m'
-typeset bold_green='\033[1;92m'
-typeset yellow='\033[0;33m'
-typeset color_reset='\033[0m'

src/marshmallow_generic/__init__.py

@@ -13,7 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License."""
 
-__version__ = "1.0.0"
+__version__ = "0.0.1"
 
 __doc__ = """
 Generic schema with full typing support and minimal boilerplate.
@@ -42,8 +42,10 @@ __all__ = [
 ]
 
 from marshmallow import fields
-from marshmallow.decorators import (  # `post_load` overloaded
+
+from marshmallow.decorators import (
     post_dump,
+    # post_load,  # overloaded
     pre_dump,
     pre_load,
     validates,