Priority: ✔ Document the python/logging/typing in Trilium @done(21-10-25 14:33) ✔ Update typing annotations to include generics instead @done(21-10-25 22:38) https://docs.python.org/3/library/collections.abc.html#collections-abstract-base-classes ☐ Write the tests ☐ test logs: document this ☐ Docstrings Documentation: Docstrings: ☐ Use Duty to write module docstrings ☐ Use Duty to add Class docstrings ☐ Document these in Trilium and rewrite the docstrings notes ☐ Add the comment on Reddit (artie buco?) about imports in a module ☐ Document using `__main__.py` and `cli.py` Use Duty as an example ☐ Write documentation using `mkdocs` ☐ Look at how to use github actions Use for an example ☐ Build the docs using a github action. Functionality: ✔ Move any `tembo.CONFIG` calls out of `pages.py` and ensure these are passed in from the cli. @done(21-10-28 19:44) ✔ Make `config scope` a dict in `cli.py`. @done(21-10-28 19:44) ☐ Add the `--example` output to the miscounted token message so the user knows the correct command to use. ✔ Page options dataclass @done(21-10-28 20:09) ☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages? ☐ Use the python runner Duty ☐ Run tests ☐ Update poetry ☐ Build docs ☐ Document using Duty VSCode: PyInstaller: ☐ Document build error: PYTHON_CONFIGURE_OPTS="--enable-framework" pyenv install 3.8.11 ☐ Freeze a click app: Tests: ☐ Write tests! @2d Use coverage as going along to make sure all bases are covered in the testing VSCode: ☐ Look at Logging: Documentation: Tembo: ☐ Document creating new Tembo config ☐ ~/tembo needs creating ☐ ~/tembo/.config ☐ ~/tembo/.templates ☐ ~/tembo/logs ☐ Document how to overwrite these with ENV vars ☐ have a git repo with all the above already configured and walk user through clone the repo, delete .git, git init, configure and add git origin Archive: ✔ Go through code TODOs @done(21-10-25 05:52) @project(Priority) ✔ Check code order and make sure things are where they should be @done(21-10-25 13:31) @project(Priority) ✔ Add version option @done(21-10-25 13:40) @project(Functionality) ✘ Document usage of Panaetius in a module @cancelled(21-10-25 13:31) @project(Logging.Documentation) ✘ Uses `strftime` tokens: @cancelled(21-10-25 13:32) @project(Logging.Documentation) ✔ Document latest typing. @done(21-10-25 14:14) @project(Logging.Documentation) ✔ Using from `__future__` with `|` @done(21-10-25 13:48) @project(Logging.Documentation) ✔ `using Tuple[str, ...]` @done(21-10-25 13:49) @project(Logging.Documentation) ✔ `Sequence` vs `Collection` @done(21-10-25 13:55) @project(Logging.Documentation) ✔ Document how to do docstrings in python. Don't document `__init__` do it in class. @done(21-10-25 13:57) @project(Logging.Documentation) ✔ Document using jinja2 briefly and link to Tembo (link to ) @done(21-10-25 14:21) @project(Logging.Documentation) ✔ How to raise + debug an exception? @done(21-10-25 14:32) @project(Logging.Documentation.Logging) ✔ Document how to raise a logger.critical instead of exception @done(21-10-25 14:32) @project(Logging.Documentation.Logging) ✔ tokens @done(21-10-25 05:35) @project(Bug) ✔ Handle case where there are no scopes in the config and command is invoked. @done(21-10-25 04:32) @project(Functionality) ✔ Have an `--example` flag to `new` that prints an example given in the `config.yml` @done(21-10-25 04:55) @project(Functionality) ✔ Should be a `tembo new --list` to list all possible names. @done(21-10-25 05:28) @project(Functionality) ✘ When template not found, raise a Tembo error @cancelled(21-10-25 05:29) @project(Functionality) ✔ Convert spaces to underscores in filepath @done(21-10-25 05:35) @project(Functionality) ✘ Add update notification? @cancelled(21-10-25 05:29) @project(Functionality) ✔ `TEMBO_CONFIG` should follow same pattern as other env vars and be a python string when read in @done(21-10-24 05:31) @project(Functionality) ✘ Uses Pendulum tokens: https://pendulum.eustace.io/docs/#tokens @cancelled(21-10-24 05:32) @project(Logging.Documentation)