adding options class and tidying up

This commit is contained in:
2021-10-28 20:11:27 +01:00
parent a0afe62879
commit 4077ec1760
4 changed files with 101 additions and 68 deletions

View File

@@ -5,24 +5,41 @@ Priority:
☐ Write the tests
☐ test logs: <https://stackoverflow.com/questions/53125305/testing-logging-output-with-pytest>
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 <https://github.com/pdm-project/pdm/tree/main/.github/workflows> 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
☐ Use the python runner Duty
<https://github.com/pawamoy/duty>
☐ Run tests
☐ Update poetry
☐ Build docs
☐ Document using Duty
VSCode:
PyInstaller:
☐ Document build error: <https://github.com/pyenv/pyenv/issues/1095>
PYTHON_CONFIGURE_OPTS="--enable-framework" pyenv install 3.8.11
☐ Freeze a click app: <https://stackoverflow.com/questions/45090083/freeze-a-program-created-with-pythons-click-pacage>
Tests:
☐ Write tests! @2d
Use coverage as going along to make sure all bases are covered in the testing
@@ -33,8 +50,6 @@ VSCode:
Logging:
Documentation:
☐ a
Tembo:
☐ Document creating new Tembo config
☐ ~/tembo needs creating