New README.md and standalone assessment "Quick Start" example files.

[TheRealEdDawson]

Info 286/new readme and quickstarts

Checklist

• [ ] Feature

• [ ] Bug

• [ ] Security

• [x] Documentation

• [ ] ChangeLog.md updated

• [ ] Tests added

• [ ] All testsuites passed

• [ ] make dist completed successfully

[shtrom]

On running the standalone assessment, and the issues that @roger-marley-lrn has ran into, namely,

1. no consistent path depending on install
2. missing dependencies

• We can work around 1. by adding a console_script, which would get installed wherever is good by the pip install .... command. See, for example, here: https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L41-L45
• We can work around 2. by installing the missing dependencies, namely Jinja2. This is a bit thorny, because Jinja is not a dependency of the sdk itself, so we shouldn't require it. We can however express optional dependencies in the setup.cfg (e.g., https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L48-L51https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L48-L51), so we could add a quickstart set of dependencies, containing Jinja2, and we could install those with pip install .[quickstart] or pip install learnosity_sdk[quickstart]

[dan-bradley-lrn]

All looks great, recommend changing from camel case to a consistent snake_case as per PEP8 standard

[TheRealEdDawson]

On running the standalone assessment, and the issues that @roger-marley-lrn has ran into, namely,

1. no consistent path depending on install
2. missing dependencies

• We can work around 1. by adding a console_script, which would get installed wherever is good by the pip install .... command. See, for example, here: https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L41-L45
• We can work around 2. by installing the missing dependencies, namely Jinja2. This is a bit thorny, because Jinja is not a dependency of the sdk itself, so we shouldn't require it. We can however express optional dependencies in the setup.cfg (e.g., https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L48-L51https://github.com/Learnosity/lrn-cli/blob/main/setup.py#L48-L51), so we could add a quickstart set of dependencies, containing Jinja2, and we could install those with pip install .[quickstart] or pip install learnosity_sdk[quickstart]

We fixed it.

[TheRealEdDawson]

All looks great, recommend changing from camel case to a consistent snake_case as per PEP8 standard

I fixed the camels versus snakes.