docs: refactor examples
Summary
Checklist
- [ ] If code changes were made, then they have been tested
- [ ] I have updated the documentation to reflect the changes
- [ ] I have formatted the code properly by running
task lint - [ ] I have type-checked the code by running
task pyright
- [ ] This PR fixes an issue
- [ ] This PR adds something new (e.g. new method or parameters)
- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
- [ ] This PR is not a code change (e.g. documentation, README, ...)
Related PR: #557
While more changes could be made to the examples, this is a good start, and I think its worth being added at this condition rather than the ideally finished one--this is still better than what we had.
~~Loading the env is done in __init__.py if the dotenv module is installed~~
No idea what this comment was initially about, I think I confused it for #247
To run with dotenv, we can actually use dotenv run python example_name.py on the command line which will load all of the environment variables before running the process.
~Loading the env is done in
__init__.pyif the dotenv module is installed~No idea what this comment was initially about, I think I confused it for #247
To run with dotenv, we can actually use
dotenv run python example_name.pyon the command line which will load all of the environment variables before running the process.
Ah. In that case, LGTM. Apologies for the late response, GitHub notifications are failing me.
not newsworthy on its own, at least not right now