mirror of
https://github.com/dtomlinson91/tembo.git
synced 2025-12-22 10:55:44 +00:00
adding latest
This commit is contained in:
33
TODO.todo
33
TODO.todo
@@ -1,16 +1,19 @@
|
||||
Priority:
|
||||
☐ Write the tests
|
||||
✔ Write the tests @done(21-11-07 15:36)
|
||||
☐ test logs: <https://stackoverflow.com/questions/53125305/testing-logging-output-with-pytest>
|
||||
document this
|
||||
☐ Docstrings
|
||||
☐ Update trilium with latest docstrings (documenting __init__ at class level etc)
|
||||
Make sure the gist is updated for prospector with the right ignores
|
||||
|
||||
Documentation:
|
||||
☐ documented poetry with extras (panaetius `pyproject.toml`)
|
||||
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`
|
||||
✔ Document using `__main__.py` and `cli.py` @done(21-11-07 15:21)
|
||||
Use Duty as an example
|
||||
|
||||
☐ Document regex usage
|
||||
@@ -31,14 +34,14 @@ Documentation:
|
||||
reading `.value.code`
|
||||
reading `str(.value)`
|
||||
|
||||
☐ Document working with exceptions
|
||||
☐ General pattern - raise exceptions in codebase, catch them in the CLI.
|
||||
✔ Document working with exceptions @done(21-11-09 22:17)
|
||||
✔ General pattern - raise exceptions in codebase, catch them in the CLI. @done(21-11-09 22:16)
|
||||
Allows people to use via an API and handle the exceptions themselves.
|
||||
You can use python builtins but custom exceptions are better for internal control
|
||||
☐ Capturing exceptions in the CLI.
|
||||
✔ Capturing exceptions in the CLI. @done(21-11-09 22:16)
|
||||
Access the message of the exception with `.args[0]`.
|
||||
use `raise SystemExit(1) from exception` in order to gracefully exit
|
||||
☐ Adding custom args to an exception
|
||||
✔ Adding custom args to an exception @done(21-11-09 22:17)
|
||||
Overwrite `__init__`, access them in pytest with `.value.$args`
|
||||
Access them in a try,except with `raise $excpetion as $name; $name.$arg`
|
||||
|
||||
@@ -60,13 +63,13 @@ Documentation:
|
||||
<https://stackoverflow.com/questions/32234156/how-to-unimport-a-python-module-which-is-already-imported>
|
||||
|
||||
Functionality:
|
||||
☐ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages?
|
||||
✔ Replace loggers with `click.echo` for command outputs. Keep logging messages for actual logging messages? @done(21-11-09 22:17)
|
||||
Define a format: [TEMBO:$datetime] $message 🐘 - document this in general python for CLI
|
||||
☐ Refactor the tembo new command so the cli is split out into manageable methods
|
||||
☐ Use the complicated CLI example so the tembo new has its own module to define functions in
|
||||
☐ Replace all logger errors with exceptions, move logger messages to the cli.
|
||||
☐ How to pass a successful save notification back to the CLI? Return a bool? Or is there some other way?
|
||||
☐ Replace pendulum with datetime
|
||||
✔ Refactor the tembo new command so the cli is split out into manageable methods @done(21-11-07 15:35)
|
||||
✘ Use the complicated CLI example so the tembo new has its own module to define functions in @cancelled(21-11-07 15:35)
|
||||
✔ Replace all logger errors with exceptions, move logger messages to the cli. @done(21-11-07 15:35)
|
||||
✔ How to pass a successful save notification back to the CLI? Return a bool? Or is there some other way? @done(21-11-07 15:35)
|
||||
✘ Replace pendulum with datetime @cancelled(21-11-07 15:35)
|
||||
✔ Make options a property on the class, add to abstract @done(21-10-30 19:31)
|
||||
☐ Use the python runner Duty
|
||||
<https://github.com/pawamoy/duty>
|
||||
@@ -78,8 +81,8 @@ Functionality:
|
||||
Need to decide what file to place `__version__` in.
|
||||
|
||||
Logging:
|
||||
☐ Make all internal tembo logs be debug
|
||||
☐ User can enable them with the config
|
||||
✘ Make all internal tembo logs be debug @cancelled(21-11-09 22:20)
|
||||
✘ User can enable them with the config @cancelled(21-11-09 22:20)
|
||||
|
||||
VSCode:
|
||||
PyInstaller:
|
||||
@@ -92,7 +95,7 @@ VSCode:
|
||||
walrus :=
|
||||
|
||||
Tests:
|
||||
☐ Write tests! @2d
|
||||
✔ Write tests! @2d @done(21-11-07 15:36)
|
||||
Use coverage as going along to make sure all bases are covered in the testing
|
||||
|
||||
VSCode:
|
||||
|
||||
Reference in New Issue
Block a user