jackson15j / python_homework_config_file_parser Goto Github PK

Create a single/multi-step Dockerfile with the ability to pass in config files at run-time.

Double check: https://github.com/pypa/setuptools_scm/#usage-from-docker if I pull in setuptools_scm for package versioning from Git.

Add a basic CI build pipeline to:

• Install pre-requisites.
• Lint.
• Build application.
• Run tests.

Rough thoughts around the Parser module to satisfy the requirements of:

• Parse config files (JSON).
• Gracefully ignore files that do not parse.
• Config files read later on MUST override values.
• Support other content schema`s outside of JSON.

Code wise, my thoughts currently are:

• parsers module:
  • IParser interface class for base file parsing to a parsed_dict.
  • JsonParser class that implements JSON parsing.
  • ... place for other file parser's. eg. YAML.

Parsing to a dictionary since it is a nested structure, built-in override
updates, and look-ups in a similar form to dotted paths.

Basic stub application to satisfy each step in the CI Build Pipeline:

• Package metadata.
• Stub function(s).
• Stub Test(s).

Design & Publish notes/diagrams(Block/Sequence) based on the requirements at:
DividoFinancialServices/config-chg.

I am decoupling the Parsing (#6) and Lookup workflows. Thinking that in the
future it would benefit workflows like:

• Non-Decoupled: "one-time parse + single lookup".
• Decoupled: "one-time parse, store/get, multiple lookups".

Code-wise, my current thoughts for a lookup module is:

• Convert dotted path to dict lookup.
• lookup value from Parser's parsed_dict.

Add a Release CI pipeline to generate and publish tags as a Github Release.