docs(parser): extract and fix code examples

[michaelbrewer]

Issue number:

• Split from: Docs: Move code snippets into dedicated python files add formatting and linting, fixing any outstanding errors #1064
• Original pr: fix(docs): extract code snippets into dedicated python files and fix examples #1065

Summary

Extract code examples from the parser utility documentation and fix python code examples

Changes

Please provide a summary of what's being changed

Changes:

• Extract code examples
• Run isort and black
• Fix python code examples with errors
• Update line highlights
• Add make task for formatting, compiling and linting examples to prevent future errors

Bug Fixes included in this PR:

• Fix missing imports for Parser - EventBridge Envelope example

User experience

Please share what the user experience looks like before and after this change

Before some examples would have errors in them, afterwords these errors where fix, also some make tasks where added to reduce future errors.

Hosted version is here: https://gyft.github.io/aws-lambda-powertools-python/latest/

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of my this change
• Changes are tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

---

View rendered docs/utilities/parser.md

[michaelbrewer]

@ran-isenberg - FYI, i have extracted the code examples for the parser utility in this PR instead of the main docs PR

[codecov-commenter]

Codecov Report

Merging #1125 (b49e336) into develop (f62d07a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1125   +/-   ##
========================================
  Coverage    99.88%   99.88%           
========================================
  Files          119      119           
  Lines         5423     5423           
  Branches       618      618           
========================================
  Hits          5417     5417           
  Misses           2        2           
  Partials         4        4           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f62d07a...b49e336. Read the comment docs.

[gshpychka]

@sthulb any insights into why these were all closed?

[heitorlessa]

Hi @gshpychka, Michael is no longer part of the Lambda Powertools community.

For any specific concerns, please feel free to email us at [email protected].

[gshpychka]

Hi @gshpychka, Michael is no longer part of the Lambda Powertools community.

For any specific concerns, please feel free to email us at [email protected].

I'm not sure what that means, but why did all his PRs have to be closed?

[ran-isenberg]

The parser and feature flags could have really benefited from the docs overhaul PRs

[heitorlessa]

We will tackle all of them, Ran. We’ll also introduce a built-in API reference docs so Parser Models (et al) can be automatically documented

…

On Thu, 23 Jun 2022 at 08:55, Ran Isenberg ***@***.***> wrote: The parser and feature flags could have really benefited from the docs overhaul PRs — Reply to this email directly, view it on GitHub <#1125 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBDYLCHGJ53L6EWZKNTVQQC5TANCNFSM5TJFEEPQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>