dtomlinson/panaetius
1
0
Fork 0
mirror of https://github.com/dtomlinson91/panaetius.git synced 2025-12-22 04:55:44 +00:00
Code Issues Projects Releases Wiki Activity

updating todos

Browse Source
This commit is contained in:
Daniel Tomlinson
2021-10-18 02:36:27 +01:00
parent 31fe9b1afc
commit d604179cbf
1 changed files with 35 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
rewrite.todo
View File

@@ -1,70 +1,43 @@
Coding:
No Config File:
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25)
needs to be lower case in the toml, need a check for this
Config File:
✔ Handle if a bool is passed in as a default @done(21-10-16 05:25)
needs to be lower case in the toml, need a check for this
Logging:
✔ Create SimpleLogger, AdvancedLogger, CustomLogger classes @done(21-10-16 16:22)
should simply have the different logging strings to output
should both specify whether to save to file or not
✔ Logging path should take by default the config path unless overwritten? @done(21-10-16 23:49)
Errors:
✔ Check logging path + config path are valid, if not raise error. @done(21-10-18 00:04)
✔ Add tests for these. @done(21-10-18 00:04)
✔ Check for a key > 2 levels, raise custom error, write test @done(21-10-17 23:30)
Linting:
✔ Check all functions and annotations. @done(21-10-18 01:07)
Docstrings:
✔ Write the docstrings for public functions/methods. @done(21-10-18 02:29)
Functionality:
✔ When both a config file and a env var is found, use the env var. @done(21-10-18 00:38)
Documentation: Documentation:
☐ Rewrite documentation using `mkdocs` and using `.md`. @2h ☐ Rewrite documentation using `mkdocs` and using `.md`.
☐ Update the metadata in the `pyproject.toml`.
☐ Create a new `Readme.md` and remove the `.rst`.
Misc: Misc:
☐ Use the python runner to build the docs & run the tests (including coverage html) ☐ Use the python runner to build the docs & run the tests (including coverage html)
coverage run -m pytest && coverage report && coverage html coverage run -m pytest && coverage report && coverage html
☐ document this in trilium ☐ document this in trilium
☐ Bump the version to release 2.0
Tests:
Bugfixes:
✔ If loading from a default, don't covert to TOML @done(21-10-17 20:33)
✔ Env Vars should be given as python objects @done(21-10-17 20:33)
The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.
use ast.literal_eval()
https://docs.python.org/3/library/ast.html#ast.literal_eval
__init__: Archive:
✔ Test default config path set to "~/.config" @done(21-10-17 17:25) ✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.No Config File)
✔ Test config path is set when passed in @done(21-10-17 17:25) ✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.Config File)
✔ Create SimpleLogger, AdvancedLogger, CustomLogger classes @done(21-10-16 16:22) @project(Coding.Logging)
config property: ✔ Logging path should take by default the config path unless overwritten? @done(21-10-16 23:49) @project(Coding.Logging)
✔ Check testing config file is returned as dict @done(21-10-17 17:25) ✔ Check logging path + config path are valid, if not raise error. @done(21-10-18 00:04) @project(Coding.Errors)
✔ Check _self.missing_config and empty dict is returned @done(21-10-17 17:25) ✔ Add tests for these. @done(21-10-18 00:04) @project(Coding.Errors)
✔ Check for a key > 2 levels, raise custom error, write test @done(21-10-17 23:30) @project(Coding.Errors)
get_value: ✔ Check all functions and annotations. @done(21-10-18 01:07) @project(Coding.Linting)
config_file: ✔ Write the docstrings for public functions/methods. @done(21-10-18 02:29) @project(Coding.Docstrings)
✔ Arrays & tables loaded correctly from config file @done(21-10-17 20:34) ✔ When both a config file and a env var is found, use the env var. @done(21-10-18 00:38) @project(Coding.Functionality)
✔ test when key length is 1 the value is returned @done(21-10-17 18:55) ✔ If loading from a default, don't covert to TOML @done(21-10-17 20:33) @project(Tests.Bugfixes)
✔ test when key length is 2 the value is returned @done(21-10-17 18:55) ✔ Env Vars should be given as python objects @done(21-10-17 20:33) @project(Tests.Bugfixes)
✔ test when key not found and no env var default is loaded @done(21-10-17 19:01) The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None.
✔ test bool's are properly converted @done(21-10-17 19:01) use ast.literal_eval()
✔ test when key not found and env var is set value is loaded @done(21-10-17 20:43) https://docs.python.org/3/library/ast.html#ast.literal_eval
✔ Test default config path set to "~/.config" @done(21-10-17 17:25) @project(Tests.__init__)
env_var: ✔ Test config path is set when passed in @done(21-10-17 17:25) @project(Tests.__init__)
✔ check if env key is missing the default is read in @done(21-10-17 20:55) ✔ Check testing config file is returned as dict @done(21-10-17 17:25) @project(Tests.config property)
✔ check if env key is present the values are read in @done(21-10-17 22:24) ✔ Check _self.missing_config and empty dict is returned @done(21-10-17 17:25) @project(Tests.config property)
✔ parametrise a test to read in values form env vars and they're set correctly @done(21-10-17 22:24) ✔ Arrays & tables loaded correctly from config file @done(21-10-17 20:34) @project(Tests.get_value.config_file)
✔ test that the env var is valid python @done(21-10-18 01:03) ✔ test when key length is 1 the value is returned @done(21-10-17 18:55) @project(Tests.get_value.config_file)
✔ test when key length is 2 the value is returned @done(21-10-17 18:55) @project(Tests.get_value.config_file)
library: ✔ test when key not found and no env var default is loaded @done(21-10-17 19:01) @project(Tests.get_value.config_file)
✔ test set_config works @done(21-10-17 23:29) ✔ test bool's are properly converted @done(21-10-17 19:01) @project(Tests.get_value.config_file)
✔ test when key not found and env var is set value is loaded @done(21-10-17 20:43) @project(Tests.get_value.config_file)
✔ check if env key is missing the default is read in @done(21-10-17 20:55) @project(Tests.get_value.env_var)
✔ check if env key is present the values are read in @done(21-10-17 22:24) @project(Tests.get_value.env_var)
✔ parametrise a test to read in values form env vars and they're set correctly @done(21-10-17 22:24) @project(Tests.get_value.env_var)
✔ test that the env var is valid python @done(21-10-18 01:03) @project(Tests.get_value.env_var)
✔ test set_config works @done(21-10-17 23:29) @project(Tests.library)