Merge branch 'feature/stub_python_package'

Initial stub parser package to build off from:

- Basic build/metadata in `pyproject.toml`.
- Dynamic versioning from last Git tag (via:
  https://github.com/pypa/setuptools_scm/).
- Stub parser file and unittest.
- Updated `README.md` on basic install steps.

Fixes #5.

Author: jackson15j

README.md

@@ -1,2 +1,26 @@
 # python_homework_config_file_parser
 Coding Test for parsing config files from first principles
+
+# Dev Notes
+
+## Pre-Reqs.
+
+1. Suggest configuring your python virtual environment of choice. eg.
+
+  ```bash
+  python -m venv .venv
+  source .venv/bin/activate
+  ```
+
+2. Install package: `pip install .`.
+3. _[OPTIONAL]_ Install optional dependencies: `pip install . [<group>]`, where
+   `<group>` is one of:
+   * `test`.
+
+## Usage
+
+**TODO**
+
+## Testing:
+
+* From repo root directory: `pytest`.

pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "config_file_parser"
+dynamic = ["version"]
+license = {file = "LICENSE"}
+authors = [
+  { name="Craig Astill", email="[email protected]" },
+]
+description = "A small example package."
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["config", "parser"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/jackson15j/python_homework_config_file_parser"
+"Bug Tracker" = "https://github.com/jackson15j/python_homework_config_file_parser/issues"
+
+[project.optional-dependencies]
+test = [
+    "pytest >= 7.2.1",
+    "pytest-cov >= 4.0.0",
+    "pytest-html >= 3.2.0",
+]
+
+[build-system]
+requires = ["setuptools>=62.6", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+# Version number construction and guessing based off most recent tag is done
+# with the following config. Going with a simple dev format, instead of the
+# opinonated versioning based off branches (which would be more useful on a
+# Release/Feature managed product.
+# See: https://github.com/pypa/setuptools_scm#version-number-construction.
+local_scheme = 'no-local-version'
+version_scheme = 'no-guess-dev'
+
+[tool.setuptools.dynamic]
+# Config for dynamic versioning from last Git tag. See:
+# https://github.com/pypa/setuptools_scm/
+version = { attr = "setuptools_scm.get_version" }
+
+[tool.pytest.ini_options]
+# Directories that are not visited by pytest collector:
+norecursedirs = [
+  "*.egg",
+  ".eggs",
+  "dist",
+  "build"
+]
+junit_suite_name = "tests"
+junit_logging = "all"
+junit_family = "xunit2"
+python_files = [
+    "test_*.py",
+    "*_test.py",
+    "tests.py"
+]
+# Report coverage and test output in JUnit format for CI to display, as well as
+# a human readable HTML.
+# Also dump 10 slowest tests on CLI runs for local debugging.
+addopts = "-ra --durations=10 --junitxml=build/test-reports/py_unittests.xml --html=build/test-reports/py_unittests.html --self-contained-html"

src/config_file_parser/__init__.py

@@ -0,0 +1,13 @@
+"""Stub Parser to get initial testing and CI off the ground."""
+from typing import Union
+
+
+def get(path: str) -> Union[None, dict, tuple, list, str, int]:
+    """Getter than is used to look up the single/section value(s) in the parsed
+    config from a supplied dot path.
+
+    :param str path: Dot notation path into the parsed config. eg.
+        "key1.subkey7".
+    :returns: The value of the key, whether it is a single value or a section.
+    """
+    return

src/config_file_parser/parser.py

@@ -0,0 +1,24 @@
+"""Stub Parser tests."""
+from src.config_file_parser import parser
+
+# TODO: move test data to a fixture!
+PARSED_DICT = {
+    "environment": "production",
+    "database": {
+        "host": "mysql",
+        "port": 3306,
+        "username": "divido",
+        "password": "divido",
+    },
+    "cache": {"redis": {"host": "redis", "port": 6379}},
+}
+
+
+class TestParserInitialRequirements:
+    """Parser tests from the initial requirements page."""
+
+    def test_get_returns_single_value(self):
+        assert parser.get("database.host") == PARSED_DICT["database"]["host"]
+
+    def test_get_returns_section_value(self):
+        assert parser.get("cache") == PARSED_DICT["cache"]