mirror of
https://github.com/dtomlinson91/tembo.git
synced 2025-12-22 08:25:44 +00:00
58 lines
2.8 KiB
Plaintext
58 lines
2.8 KiB
Plaintext
Priority:
|
|
✔ Go through code TODOs @done(21-10-25 05:52)
|
|
☐ Check code order and make sure things are where they should be
|
|
☐ Document the python/logging/typing in Trilium
|
|
☐ Write the tests
|
|
|
|
Functionality:
|
|
☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages
|
|
|
|
Bug:
|
|
|
|
Tests:
|
|
☐ Write tests! @2d
|
|
Use coverage as going along to make sure all bases are covered in the testing
|
|
|
|
VSCode:
|
|
☐ Look at <https://github.com/CodeWithSwastik/vscode-ext>
|
|
|
|
Logging:
|
|
|
|
Documentation:
|
|
☐ Document usage of Panaetius in a module
|
|
Using the logger, initialising with the config path etc
|
|
☐ Uses `strftime` tokens: <https://strftime.org>
|
|
☐ Document latest typing.
|
|
☐ Using from `__future__` with `|`
|
|
☐ `using Tuple[str, ...]`
|
|
☐ `Sequence` vs `Collection`
|
|
☐ Document how to do docstrings in python. Don't document `__init__` do it in class.
|
|
Should update the default gist to hide the `__init__` messages
|
|
☐ Document using jinja2 briefly and link to Tembo (link to <https://zetcode.com/python/jinja/>)
|
|
|
|
Logging:
|
|
☐ How to raise + debug an exception?
|
|
☐ Document how to raise a logger.critical instead of exception
|
|
in a try, except you can just do logger.critical(exec_info=1) to print the stack
|
|
|
|
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:
|
|
✔ 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)
|