diff --git a/README.md b/README.md new file mode 100644 index 0000000..f933352 --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# Panaetius + +This package provides: + +- Functionality to read user variables from a `config.yml` or environment variables. +- A convenient default logging formatter printing `json` that can save to disk and rotate. +- Utility functions. + +## Config + +### options + +#### skip_header_init + +If `skip_header_init=True` then the `config_path` will not use the `header_variable` as the +sub-directory in the `config_path`. + +E.g + +`CONFIG = panaetius.Config("tembo", "~/tembo/.config", skip_header_init=True)` + +Will look in `~/tembo/config/config.yml`. + +If `skip_header_init=False` then would look in `~/tembo/config/tembo/config.yml`. + +### Module + +Convenient to place in a package/sub-package `__init__.py`. + +See Tembo for an example: + +Example snippet to use in a module: + +```python +import os + +import panaetius +from panaetius.exceptions import LoggingDirectoryDoesNotExistException + + +if (config_path := os.environ.get("TEMBO_CONFIG")) is not None: + CONFIG = panaetius.Config("tembo", config_path, skip_header_init=True) +else: + CONFIG = panaetius.Config("tembo", "~/tembo/.config", skip_header_init=True) + + +panaetius.set_config(CONFIG, "base_path", "~/tembo") +panaetius.set_config(CONFIG, "template_path", "~/tembo/.templates") +panaetius.set_config(CONFIG, "scopes", {}) +panaetius.set_config(CONFIG, "logging.level", "DEBUG") +panaetius.set_config(CONFIG, "logging.path") + +try: + logger = panaetius.set_logger( + CONFIG, panaetius.SimpleLogger(logging_level=CONFIG.logging_level) + ) +except LoggingDirectoryDoesNotExistException: + _LOGGING_PATH = CONFIG.logging_path + CONFIG.logging_path = "" + logger = panaetius.set_logger( + CONFIG, panaetius.SimpleLogger(logging_level=CONFIG.logging_level) + ) + logger.warning("Logging directory %s does not exist", _LOGGING_PATH) + +``` + +This means in `./tembo/cli/cli.py` you can + +```python +import tembo.cli + +# access the CONFIG instance + variables from the config.yml +tembo.cli.CONFIG +``` + + +## Utility Functions + +### Squasher + +Squashes a json object or Python dictionary into a single level dictionary. diff --git a/README.rst b/README.rst deleted file mode 100644 index e86c2bb..0000000 --- a/README.rst +++ /dev/null @@ -1,62 +0,0 @@ -Author -======= - -Daniel Tomlinson (dtomlinson@panaetius.co.uk) - -Requires -========= - -`>= python3.7` - -Python requirements -==================== - -- toml = "^0.10.0" -- pylite = "^0.1.0" - -Documentation -============== - -Read the documentation on `read the docs`_. - -.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html - -Installation -============== - -You can install ``panaetius`` the following ways: - -Python -------- - -.. Attention:: You should install in a python virtual environment - -From pypi using pip -~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: bash - - pip install panaetius - -From local wheel -~~~~~~~~~~~~~~~~~ - -Download the latest verion from the `releases`_ page. - -.. _releases: https://github.com/dtomlinson91/panaetius/releases - -Install with pip: - -.. code-block:: bash - - pip install -U panaetius-1.0.2-py3-none-any.whl - - -From source -~~~~~~~~~~~~ - -Clone the repo and install using ``setup.py``: - -.. code-block:: bash - - python setup.py diff --git a/duties.py b/duties.py new file mode 100644 index 0000000..03216d4 --- /dev/null +++ b/duties.py @@ -0,0 +1,103 @@ +from __future__ import annotations + +import os +import pathlib +import re +import shutil + +from duty import duty + + +PACKAGE_NAME = "panaetius" + + +@duty +def update_deps(ctx, dry: bool = False): + """ + Update the dependencies using Poetry. + + Example: + `duty update_deps dry=False` + """ + dry_run = "--dry-run" if dry else "" + ctx.run( + ["poetry", "update", dry_run], + title=f"Updating poetry deps {dry_run}", + ) + + +@duty +def test(ctx): + """Run tests using pytest""" + pytest_results = ctx.run(["pytest", "-v"]) + print(pytest_results) + + +@duty +def coverage(ctx): + """ + Generate a coverage HTML report. + + Example: + `duty coverage` + """ + ctx.run(["coverage", "run", "--source", PACKAGE_NAME, "-m", "pytest"]) + ctx.run(["coverage", "html"]) + + +@duty +def version(ctx, bump: str = "patch"): + """ + Bump the version using Poetry and update _version.py. + + Args: + bump (str, optional) = poetry version flag. Available options are: + patch, minor, major, prepatch, preminor, premajor, prerelease. + Defaults to patch. + + Example: + `duty version bump=major` + """ + + # bump with poetry + result = ctx.run(["poetry", "version", bump]) + new_version = re.search(r"(?:.*)(?:\s)(\d+\.\d+\.\d+)$", result) + print(new_version.group(0)) + + # update _version.py + version_file = pathlib.Path(PACKAGE_NAME) / "_version.py" + with version_file.open("w", encoding="utf-8") as version_file: + version_file.write( + f'"""Module containing the version of {PACKAGE_NAME}."""\n\n' + + f'__version__ = "{new_version.group(1)}"\n' + ) + print(f"Bumped _version.py to {new_version.group(1)}") + + +@duty +def build(ctx): + """ + Build with poetry and extract the `setup.py` and copy to project root. + + Example: + `duty build` + """ + + repo_root = pathlib.Path(".") + + # build with poetry + result = ctx.run(["poetry", "build"]) + print(result) + + # extract the setup.py from the tar + extracted_tar = re.search(r"(?:.*)(?:Built\s)(.*)", result) + tar_file = pathlib.Path(f"./dist/{extracted_tar.group(1)}") + shutil.unpack_archive(tar_file, tar_file.parents[0]) + + # copy setup.py to repo root + extracted_path = tar_file.parents[0] / os.path.splitext(tar_file.stem)[0] + setup_py = extracted_path / "setup.py" + shutil.copyfile(setup_py, (repo_root / "setup.py")) + + # cleanup + shutil.rmtree(extracted_path) diff --git a/panaetius/__init__.py b/panaetius/__init__.py index 6a0c396..85e948d 100644 --- a/panaetius/__init__.py +++ b/panaetius/__init__.py @@ -1,5 +1,7 @@ """ -panaetius - a utility library to read variables and provide convenient logging. +Panaetius package. + +A utility library to read variables and provide convenient logging. Author: Daniel Tomlinson (dtomlinson@panaetius.co.uk) """ diff --git a/panaetius/_version.py b/panaetius/_version.py new file mode 100644 index 0000000..8a6fc0a --- /dev/null +++ b/panaetius/_version.py @@ -0,0 +1,3 @@ +"""Module containing the version of panaetius.""" + +__version__ = "2.3.1" diff --git a/panaetius/config.py b/panaetius/config.py index 3677acf..af15b0e 100644 --- a/panaetius/config.py +++ b/panaetius/config.py @@ -1,5 +1,5 @@ """ -Access variables from a config file or an environment variable. +Config module to access variables from a config file or an environment variable. This module defines the `Config` class to interact and read variables from either a `config.yml` or an environment variable. @@ -19,7 +19,16 @@ from panaetius.exceptions import KeyErrorTooDeepException class Config: - """The configuration class to access variables.""" + """ + A configuration class to access user variables. + + Args: + header_variable (str): the `header` variable. + config_path (str|None=None): the path where the header directory is stored. + skip_header_init (bool=False): if True will not use a header subdirectory in the + `config_path`. + + """ def __init__( self, @@ -60,10 +69,12 @@ class Config: @property def config(self) -> dict: """ - Return the contents of the config file. If missing returns an empty dictionary. + Return the contents of the config file. + + If no config file is specified then this returns an empty dictionary. Returns: - dict: The contents of the `.yml` loaded as a python dictionary. + dict: The contents of the config `.yml` loaded as a python dictionary. """ if self.skip_header_init: config_file_location = self.config_path / "config.yml" diff --git a/panaetius/exceptions.py b/panaetius/exceptions.py index 0e03564..306b94f 100644 --- a/panaetius/exceptions.py +++ b/panaetius/exceptions.py @@ -1,13 +1,13 @@ -"""Exceptions for the module.""" +"""Module that defines custom exceptions for Panetius.""" class KeyErrorTooDeepException(Exception): - pass + """Raised if the keys in the config.yml are nested too deeply.""" class LoggingDirectoryDoesNotExistException(Exception): - pass + """Raised if the logging directory does not exist.""" class InvalidPythonException(Exception): - pass + """Raised if the environement variable Python type is invalid.""" diff --git a/panaetius/logging.py b/panaetius/logging.py index a307af3..d23c06a 100644 --- a/panaetius/logging.py +++ b/panaetius/logging.py @@ -63,11 +63,17 @@ def set_logger(config_inst: Config, logging_format_inst: LoggingData) -> logging # configure file handler if config_inst.logging_path is not None: - logging_file = ( - pathlib.Path(config_inst.logging_path) - / config_inst.header_variable - / f"{config_inst.header_variable}.log" - ).expanduser() + if not config_inst.skip_header_init: + logging_file = ( + pathlib.Path(config_inst.logging_path) + / config_inst.header_variable + / f"{config_inst.header_variable}.log" + ).expanduser() + else: + logging_file = ( + pathlib.Path(config_inst.logging_path) + / f"{config_inst.header_variable}.log" + ).expanduser() if not logging_file.parents[0].exists(): raise LoggingDirectoryDoesNotExistException() diff --git a/panaetius/utilities/__init__.py b/panaetius/utilities/__init__.py index 7e54de0..d89f2c8 100644 --- a/panaetius/utilities/__init__.py +++ b/panaetius/utilities/__init__.py @@ -1,3 +1,3 @@ -"""General utilities.""" +"""Sub-package which defines general utility functions.""" from panaetius.utilities.squasher import Squash diff --git a/panaetius/utilities/squasher.py b/panaetius/utilities/squasher.py index b0f81a9..1ec1147 100644 --- a/panaetius/utilities/squasher.py +++ b/panaetius/utilities/squasher.py @@ -1,4 +1,4 @@ -"""Squash a json object or Python dictionary into a single level dictionary.""" +"""Sub-module that defines squashing json objects into a single json object.""" from __future__ import annotations diff --git a/poetry.lock b/poetry.lock index 3302112..711b9f8 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,3 +1,18 @@ +[[package]] +name = "ansimarkup" +version = "1.5.0" +description = "Produce colored terminal text with an xml-like markup" +category = "dev" +optional = false +python-versions = "*" + +[package.dependencies] +colorama = "*" + +[package.extras] +devel = ["bumpversion (>=0.5.2)", "check-manifest (>=0.35)", "readme-renderer (>=16.0)", "flake8", "pep8-naming"] +tests = ["tox (>=2.6.0)", "pytest (>=3.0.3)", "pytest-cov (>=2.3.1)"] + [[package]] name = "astroid" version = "2.8.2" @@ -49,6 +64,14 @@ PyYAML = ">=5.3.1" six = ">=1.10.0" stevedore = ">=1.20.0" +[[package]] +name = "cached-property" +version = "1.5.2" +description = "A decorator for caching properties in classes." +category = "dev" +optional = false +python-versions = "*" + [[package]] name = "colorama" version = "0.4.4" @@ -76,6 +99,18 @@ category = "dev" optional = false python-versions = "*" +[[package]] +name = "duty" +version = "0.7.0" +description = "A simple task runner." +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +cached-property = {version = ">=1.5,<2.0", markers = "python_version < \"3.8\""} +failprint = ">=0.8,<1.0" + [[package]] name = "execnet" version = "1.9.0" @@ -87,6 +122,19 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.extras] testing = ["pre-commit"] +[[package]] +name = "failprint" +version = "0.8.0" +description = "Run a command, print its output only if it fails." +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +ansimarkup = ">=1.4,<2.0" +jinja2 = ">=2.11,<4" +ptyprocess = {version = ">=0.6,<1.0", markers = "sys_platform != \"win32\""} + [[package]] name = "flake8" version = "2.3.0" @@ -173,6 +221,20 @@ requirements_deprecated_finder = ["pipreqs", "pip-api"] colors = ["colorama (>=0.4.3,<0.5.0)"] plugins = ["setuptools"] +[[package]] +name = "jinja2" +version = "3.0.3" +description = "A very fast and expressive template engine." +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +MarkupSafe = ">=2.0" + +[package.extras] +i18n = ["Babel (>=2.7)"] + [[package]] name = "lazy-object-proxy" version = "1.6.0" @@ -181,6 +243,14 @@ category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" +[[package]] +name = "markupsafe" +version = "2.0.1" +description = "Safely add untrusted strings to HTML/XML markup." +category = "dev" +optional = false +python-versions = ">=3.6" + [[package]] name = "mccabe" version = "0.6.1" @@ -315,6 +385,14 @@ with_mypy = ["mypy (>=0.600)"] with_pyroma = ["pyroma (>=2.4)"] with_vulture = ["vulture (>=1.5)"] +[[package]] +name = "ptyprocess" +version = "0.7.0" +description = "Run a subprocess in a pseudo terminal" +category = "dev" +optional = false +python-versions = "*" + [[package]] name = "py" version = "1.10.0" @@ -613,9 +691,13 @@ testing = ["pytest (>=4.6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytes [metadata] lock-version = "1.1" python-versions = "^3.7" -content-hash = "f68e5ab35a155ce5ea567b670f93f4678b6c65d1335017b21431b315297a0410" +content-hash = "dcca7e2e7b6854ab40c11f6e3385b08fffb34b874981f1079205855badd7caea" [metadata.files] +ansimarkup = [ + {file = "ansimarkup-1.5.0-py2.py3-none-any.whl", hash = "sha256:3146ca74af5f69e48a9c3d41b31085c0d6378f803edeb364856d37c11a684acf"}, + {file = "ansimarkup-1.5.0.tar.gz", hash = "sha256:96c65d75bbed07d3dcbda8dbede8c2252c984f90d0ca07434b88a6bbf345fad3"}, +] astroid = [ {file = "astroid-2.8.2-py3-none-any.whl", hash = "sha256:9eaeaf92b3e21b70bec1a262e7eb118d2e96294892a5de595c92a12adc80dfc2"}, {file = "astroid-2.8.2.tar.gz", hash = "sha256:304e99c129794f2cfda584a12b71fde85205da950e2f330f4be09150525ae949"}, @@ -632,6 +714,10 @@ bandit = [ {file = "bandit-1.7.0-py3-none-any.whl", hash = "sha256:216be4d044209fa06cf2a3e51b319769a51be8318140659719aa7a115c35ed07"}, {file = "bandit-1.7.0.tar.gz", hash = "sha256:8a4c7415254d75df8ff3c3b15cfe9042ecee628a1e40b44c15a98890fbfc2608"}, ] +cached-property = [ + {file = "cached-property-1.5.2.tar.gz", hash = "sha256:9fa5755838eecbb2d234c3aa390bd80fbd3ac6b6869109bfc1b499f7bd89a130"}, + {file = "cached_property-1.5.2-py2.py3-none-any.whl", hash = "sha256:df4f613cf7ad9a588cc381aaf4a512d26265ecebd5eb9e1ba12f1319eb85a6a0"}, +] colorama = [ {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, @@ -675,10 +761,18 @@ dodgy = [ {file = "dodgy-0.2.1-py3-none-any.whl", hash = "sha256:51f54c0fd886fa3854387f354b19f429d38c04f984f38bc572558b703c0542a6"}, {file = "dodgy-0.2.1.tar.gz", hash = "sha256:28323cbfc9352139fdd3d316fa17f325cc0e9ac74438cbba51d70f9b48f86c3a"}, ] +duty = [ + {file = "duty-0.7.0-py3-none-any.whl", hash = "sha256:45068baf1639f16464aa40e9d8f698f0ae09408368fe53a34e9bfe6993dfd743"}, + {file = "duty-0.7.0.tar.gz", hash = "sha256:5ebfd4640ab41e3058f1d8433f74228d60c9a808def1784e65319ef1899a9d15"}, +] execnet = [ {file = "execnet-1.9.0-py2.py3-none-any.whl", hash = "sha256:a295f7cc774947aac58dde7fdc85f4aa00c42adf5d8f5468fc630c1acf30a142"}, {file = "execnet-1.9.0.tar.gz", hash = "sha256:8f694f3ba9cc92cab508b152dcfe322153975c29bda272e2fd7f3f00f36e47c5"}, ] +failprint = [ + {file = "failprint-0.8.0-py3-none-any.whl", hash = "sha256:a8215a7aca5ce687116b995cd3a9667180f222ab88c4328a5007d2fa0b5c0f78"}, + {file = "failprint-0.8.0.tar.gz", hash = "sha256:4633b52f9395bf042ad996c96cd7819a94b2021833030dd1eb692ebbd86b89a1"}, +] flake8 = [ {file = "flake8-2.3.0-py2.py3-none-any.whl", hash = "sha256:c99cc9716d6655d9c8bcb1e77632b8615bf0abd282d7abd9f5c2148cad7fc669"}, {file = "flake8-2.3.0.tar.gz", hash = "sha256:5ee1a43ccd0716d6061521eec6937c983efa027793013e572712c4da55c7c83e"}, @@ -707,6 +801,10 @@ isort = [ {file = "isort-5.9.3-py3-none-any.whl", hash = "sha256:e17d6e2b81095c9db0a03a8025a957f334d6ea30b26f9ec70805411e5c7c81f2"}, {file = "isort-5.9.3.tar.gz", hash = "sha256:9c2ea1e62d871267b78307fe511c0838ba0da28698c5732d54e2790bf3ba9899"}, ] +jinja2 = [ + {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, + {file = "Jinja2-3.0.3.tar.gz", hash = "sha256:611bb273cd68f3b993fabdc4064fc858c5b47a973cb5aa7999ec1ba405c87cd7"}, +] lazy-object-proxy = [ {file = "lazy-object-proxy-1.6.0.tar.gz", hash = "sha256:489000d368377571c6f982fba6497f2aa13c6d1facc40660963da62f5c379726"}, {file = "lazy_object_proxy-1.6.0-cp27-cp27m-macosx_10_14_x86_64.whl", hash = "sha256:c6938967f8528b3668622a9ed3b31d145fab161a32f5891ea7b84f6b790be05b"}, @@ -731,6 +829,77 @@ lazy-object-proxy = [ {file = "lazy_object_proxy-1.6.0-cp39-cp39-win32.whl", hash = "sha256:1fee665d2638491f4d6e55bd483e15ef21f6c8c2095f235fef72601021e64f61"}, {file = "lazy_object_proxy-1.6.0-cp39-cp39-win_amd64.whl", hash = "sha256:f5144c75445ae3ca2057faac03fda5a902eff196702b0a24daf1d6ce0650514b"}, ] +markupsafe = [ + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d7d807855b419fc2ed3e631034685db6079889a1f01d5d9dac950f764da3dad"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:add36cb2dbb8b736611303cd3bfcee00afd96471b09cda130da3581cbdc56a6d"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:168cd0a3642de83558a5153c8bd34f175a9a6e7f6dc6384b9655d2697312a646"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:4dc8f9fb58f7364b63fd9f85013b780ef83c11857ae79f2feda41e270468dd9b"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:20dca64a3ef2d6e4d5d615a3fd418ad3bde77a47ec8a23d984a12b5b4c74491a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:cdfba22ea2f0029c9261a4bd07e830a8da012291fbe44dc794e488b6c9bb353a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win32.whl", hash = "sha256:99df47edb6bda1249d3e80fdabb1dab8c08ef3975f69aed437cb69d0a5de1e28"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:e0f138900af21926a02425cf736db95be9f4af72ba1bb21453432a07f6082134"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:f9081981fe268bd86831e5c75f7de206ef275defcb82bc70740ae6dc507aee51"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:0955295dd5eec6cb6cc2fe1698f4c6d84af2e92de33fbcac4111913cd100a6ff"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:0446679737af14f45767963a1a9ef7620189912317d095f2d9ffa183a4d25d2b"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:f826e31d18b516f653fe296d967d700fddad5901ae07c622bb3705955e1faa94"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:fa130dd50c57d53368c9d59395cb5526eda596d3ffe36666cd81a44d56e48872"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:905fec760bd2fa1388bb5b489ee8ee5f7291d692638ea5f67982d968366bef9f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bf5d821ffabf0ef3533c39c518f3357b171a1651c1ff6827325e4489b0e46c3c"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:0d4b31cc67ab36e3392bbf3862cfbadac3db12bdd8b02a2731f509ed5b829724"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:baa1a4e8f868845af802979fcdbf0bb11f94f1cb7ced4c4b8a351bb60d108145"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:deb993cacb280823246a026e3b2d81c493c53de6acfd5e6bfe31ab3402bb37dd"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:63f3268ba69ace99cab4e3e3b5840b03340efed0948ab8f78d2fd87ee5442a4f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:8d206346619592c6200148b01a2142798c989edcb9c896f9ac9722a99d4e77e6"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-win32.whl", hash = "sha256:6c4ca60fa24e85fe25b912b01e62cb969d69a23a5d5867682dd3e80b5b02581d"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b2f4bf27480f5e5e8ce285a8c8fd176c0b03e93dcc6646477d4630e83440c6a9"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0717a7390a68be14b8c793ba258e075c6f4ca819f15edfc2a3a027c823718567"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:6557b31b5e2c9ddf0de32a691f2312a32f77cd7681d8af66c2692efdbef84c18"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:49e3ceeabbfb9d66c3aef5af3a60cc43b85c33df25ce03d0031a608b0a8b2e3f"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:d7f9850398e85aba693bb640262d3611788b1f29a79f0c93c565694658f4071f"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:6a7fae0dd14cf60ad5ff42baa2e95727c3d81ded453457771d02b7d2b3f9c0c2"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:b7f2d075102dc8c794cbde1947378051c4e5180d52d276987b8d28a3bd58c17d"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e9936f0b261d4df76ad22f8fee3ae83b60d7c3e871292cd42f40b81b70afae85"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:2a7d351cbd8cfeb19ca00de495e224dea7e7d919659c2841bbb7f420ad03e2d6"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:60bf42e36abfaf9aff1f50f52644b336d4f0a3fd6d8a60ca0d054ac9f713a864"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d6c7ebd4e944c85e2c3421e612a7057a2f48d478d79e61800d81468a8d842207"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f0567c4dc99f264f49fe27da5f735f414c4e7e7dd850cfd8e69f0862d7c74ea9"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:89c687013cb1cd489a0f0ac24febe8c7a666e6e221b783e53ac50ebf68e45d86"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-win32.whl", hash = "sha256:a30e67a65b53ea0a5e62fe23682cfe22712e01f453b95233b25502f7c61cb415"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:611d1ad9a4288cf3e3c16014564df047fe08410e628f89805e475368bd304914"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5bb28c636d87e840583ee3adeb78172efc47c8b26127267f54a9c0ec251d41a9"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:be98f628055368795d818ebf93da628541e10b75b41c559fdf36d104c5787066"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:1d609f577dc6e1aa17d746f8bd3c31aa4d258f4070d61b2aa5c4166c1539de35"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:7d91275b0245b1da4d4cfa07e0faedd5b0812efc15b702576d103293e252af1b"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:01a9b8ea66f1658938f65b93a85ebe8bc016e6769611be228d797c9d998dd298"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:47ab1e7b91c098ab893b828deafa1203de86d0bc6ab587b160f78fe6c4011f75"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:97383d78eb34da7e1fa37dd273c20ad4320929af65d156e35a5e2d89566d9dfb"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fcf051089389abe060c9cd7caa212c707e58153afa2c649f00346ce6d260f1b"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5855f8438a7d1d458206a2466bf82b0f104a3724bf96a1c781ab731e4201731a"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3dd007d54ee88b46be476e293f48c85048603f5f516008bee124ddd891398ed6"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aca6377c0cb8a8253e493c6b451565ac77e98c2951c45f913e0b52facdcff83f"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:04635854b943835a6ea959e948d19dcd311762c5c0c6e1f0e16ee57022669194"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6300b8454aa6930a24b9618fbb54b5a68135092bc666f7b06901f897fa5c2fee"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-win32.whl", hash = "sha256:023cb26ec21ece8dc3907c0e8320058b2e0cb3c55cf9564da612bc325bed5e64"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:984d76483eb32f1bcb536dc27e4ad56bba4baa70be32fa87152832cdd9db0833"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:2ef54abee730b502252bcdf31b10dacb0a416229b72c18b19e24a4509f273d26"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3c112550557578c26af18a1ccc9e090bfe03832ae994343cfdacd287db6a6ae7"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_i686.whl", hash = "sha256:53edb4da6925ad13c07b6d26c2a852bd81e364f95301c66e930ab2aef5b5ddd8"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:f5653a225f31e113b152e56f154ccbe59eeb1c7487b39b9d9f9cdb58e6c79dc5"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:4efca8f86c54b22348a5467704e3fec767b2db12fc39c6d963168ab1d3fc9135"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:ab3ef638ace319fa26553db0624c4699e31a28bb2a835c5faca8f8acf6a5a902"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:f8ba0e8349a38d3001fae7eadded3f6606f0da5d748ee53cc1dab1d6527b9509"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c47adbc92fc1bb2b3274c4b3a43ae0e4573d9fbff4f54cd484555edbf030baf1"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:37205cac2a79194e3750b0af2a5720d95f786a55ce7df90c3af697bfa100eaac"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:1f2ade76b9903f39aa442b4aadd2177decb66525062db244b35d71d0ee8599b6"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4296f2b1ce8c86a6aea78613c34bb1a672ea0e3de9c6ba08a960efe0b0a09047"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f02365d4e99430a12647f09b6cc8bab61a6564363f313126f775eb4f6ef798e"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5b6d930f030f8ed98e3e6c98ffa0652bdb82601e7a016ec2ab5d7ff23baa78d1"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-win32.whl", hash = "sha256:10f82115e21dc0dfec9ab5c0223652f7197feb168c940f3ef61563fc2d6beb74"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:693ce3f9e70a6cf7d2fb9e6c9d8b204b6b39897a2c4a1aa65728d5ac97dcc1d8"}, + {file = "MarkupSafe-2.0.1.tar.gz", hash = "sha256:594c67807fb16238b30c44bdf74f36c02cdf22d1c8cda91ef8a0ed8dabf5620a"}, +] mccabe = [ {file = "mccabe-0.6.1-py2.py3-none-any.whl", hash = "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42"}, {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"}, @@ -792,6 +961,10 @@ prospector = [ {file = "prospector-1.5.1-py3-none-any.whl", hash = "sha256:47f8ff3fd36ae276967eb392ca20b300a7bdea66c0d0252250a4d89a6c03ab15"}, {file = "prospector-1.5.1.tar.gz", hash = "sha256:851c2892cd615cfee91fd27cfaf7a5061d14daf2853aa8f012e927b98f919578"}, ] +ptyprocess = [ + {file = "ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35"}, + {file = "ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220"}, +] py = [ {file = "py-1.10.0-py2.py3-none-any.whl", hash = "sha256:3b80836aa6d1feeaa108e046da6423ab8f6ceda6468545ae8d02d9d58d18818a"}, {file = "py-1.10.0.tar.gz", hash = "sha256:21b81bda15b66ef5e1a777a21c4dcd9c20ad3efd0b3f817e7a809035269e1bd3"}, diff --git a/pyproject.toml b/pyproject.toml index 0f12505..aea3687 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "panaetius" -version = "2.2.2" +version = "2.3.1" description = "Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly formatted logger instance." license = "MIT" authors = ["dtomlinson "] @@ -34,6 +34,7 @@ pytest = "^6.2.5" pytest-datadir = "^1.3.1" pytest-xdist = "^2.4.0" coverage = "^6.0.2" +duty = "^0.7.0" [build-system] requires = ["poetry>=0.12"] diff --git a/rewrite.todo b/rewrite.todo index bb99cef..7fe7bb4 100644 --- a/rewrite.todo +++ b/rewrite.todo @@ -1,11 +1,8 @@ Testing: To Write: - ☐ Test the Config file skipping header with `skip_header_init` ☐ Document coverage commands `coverage run --source=./panaetius -m pytest` `coverage report` & `coverage html` > gives ./htmlcov/index.html - ☐ Document for abstract methods should raise NotImplementedError - ☐ Document https://stackoverflow.com/a/9212387 Documentation: ☐ Rewrite documentation using `mkdocs` and using `.md`. ☐ Update the metadata in the `pyproject.toml`. @@ -13,13 +10,19 @@ Documentation: ☐ Document the logging strategy CLI tools should use `logger.critical` and raise SystemExit(1) Libraries should raise custom errors and have a `logger.critical(exec_info=1)` - +Typing: + ☐ Go over typing, make sure what's passed in are generics where possible. +Docstrings: + ☐ Update class docstrings so attributes are in class. Misc: ☐ Use the python runner to build the docs & run the tests (including coverage html) coverage run -m pytest && coverage report && coverage html ☐ document this in trilium Archive: + ✔ Test the Config file skipping header with `skip_header_init` @done(21-10-25 23:34) @project(Testing.To Write) + ✔ Document for abstract methods should raise NotImplementedError @done(21-10-25 23:39) @project(Testing.To Write) + ✔ Document https://stackoverflow.com/a/9212387 @done(21-10-25 23:40) @project(Testing.To Write) ✘ Bump the version to release 2.0 @cancelled(21-10-23 05:36) @project(Misc) ✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.No Config File) ✔ Handle if a bool is passed in as a default @done(21-10-16 05:25) @project(Coding.Config File)