From 30442a5b4d302f87d78f2a1577d0f9251ab097be Mon Sep 17 00:00:00 2001 From: Vignesh Rao Date: Tue, 13 Aug 2024 10:08:20 -0500 Subject: [PATCH] Update runbook --- README.md | 4 ++-- doc_gen/static.css | 3 +++ docs/README.html | 4 ++-- docs/README.md | 4 ++-- docs/_sources/README.md.txt | 4 ++-- docs/_static/static.css | 3 +++ docs/index.html | 8 ++++++++ docs/searchindex.js | 2 +- 8 files changed, 23 insertions(+), 9 deletions(-) create mode 100644 doc_gen/static.css create mode 100644 docs/_static/static.css diff --git a/README.md b/README.md index c72d249..a60f557 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ Licensed under the [MIT License][license] [3.10]: https://docs.python.org/3/whatsnew/3.10.html [3.11]: https://docs.python.org/3/whatsnew/3.11.html [virtual environment]: https://docs.python.org/3/tutorial/venv.html -[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst +[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml @@ -142,5 +142,5 @@ Licensed under the [MIT License][license] [pypi]: https://pypi.org/project/nctl [pypi-files]: https://pypi.org/project/nctl/#files [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ -[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE +[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE [runbook]: https://thevickypedia.github.io/nctl/ diff --git a/doc_gen/static.css b/doc_gen/static.css new file mode 100644 index 0000000..3b4addd --- /dev/null +++ b/doc_gen/static.css @@ -0,0 +1,3 @@ +.sphinxsidebarwrapper { + overflow-y: scroll; +} diff --git a/docs/README.html b/docs/README.html index 4ad679c..3a234ad 100644 --- a/docs/README.html +++ b/docs/README.html @@ -115,7 +115,7 @@

Coding StandardsPEP 8 and isort

-

Release Notes

+

Release Notes

Requirement

python -m pip install gitverse
@@ -151,7 +151,7 @@

Runbook

License & copyright

© Vignesh Rao

-

Licensed under the MIT License

+

Licensed under the MIT License

diff --git a/docs/README.md b/docs/README.md index c72d249..a60f557 100644 --- a/docs/README.md +++ b/docs/README.md @@ -131,7 +131,7 @@ Licensed under the [MIT License][license] [3.10]: https://docs.python.org/3/whatsnew/3.10.html [3.11]: https://docs.python.org/3/whatsnew/3.11.html [virtual environment]: https://docs.python.org/3/tutorial/venv.html -[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst +[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml @@ -142,5 +142,5 @@ Licensed under the [MIT License][license] [pypi]: https://pypi.org/project/nctl [pypi-files]: https://pypi.org/project/nctl/#files [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ -[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE +[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE [runbook]: https://thevickypedia.github.io/nctl/ diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt index c72d249..a60f557 100644 --- a/docs/_sources/README.md.txt +++ b/docs/_sources/README.md.txt @@ -131,7 +131,7 @@ Licensed under the [MIT License][license] [3.10]: https://docs.python.org/3/whatsnew/3.10.html [3.11]: https://docs.python.org/3/whatsnew/3.11.html [virtual environment]: https://docs.python.org/3/tutorial/venv.html -[release-notes]: https://github.com/thevickypedia/nctl/blob/master/release_notes.rst +[release-notes]: https://github.com/thevickypedia/nctl/blob/main/release_notes.rst [gha_pages]: https://github.com/thevickypedia/nctl/actions/workflows/pages/pages-build-deployment [gha_pypi]: https://github.com/thevickypedia/nctl/actions/workflows/python-publish.yaml [gha_md_valid]: https://github.com/thevickypedia/nctl/actions/workflows/markdown.yaml @@ -142,5 +142,5 @@ Licensed under the [MIT License][license] [pypi]: https://pypi.org/project/nctl [pypi-files]: https://pypi.org/project/nctl/#files [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/ -[license]: https://github.com/thevickypedia/nctl/blob/master/LICENSE +[license]: https://github.com/thevickypedia/nctl/blob/main/LICENSE [runbook]: https://thevickypedia.github.io/nctl/ diff --git a/docs/_static/static.css b/docs/_static/static.css new file mode 100644 index 0000000..3b4addd --- /dev/null +++ b/docs/_static/static.css @@ -0,0 +1,3 @@ +.sphinxsidebarwrapper { + overflow-y: scroll; +} diff --git a/docs/index.html b/docs/index.html index c91eb1c..20bdf2d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -254,6 +254,14 @@

Models nctl.squire.run_validations() → None

Validates the loaded environment variables and checks ngrok CLI availability.

+
+
Raises:
+
    +

  • AssertionError –

    • +

  • If any of the validations fail. –

    • +
+
+
diff --git a/docs/searchindex.js b/docs/searchindex.js index 6461e91..021c4a8 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["NCTL", "Welcome to NCTL\u2019s documentation!"], "terms": {"fuse": 0, "ngrok": [0, 1], "cloudfront": 0, "offer": 0, "fulli": 0, "autom": 0, "solut": 0, "platform": 0, "support": 0, "deploy": 0, "recommend": 0, "instal": 0, "python": 0, "3": 0, "10": 0, "11": 0, "us": [0, 1], "dedic": [0, 1], "virtual": 0, "m": 0, "pip": 0, "initi": [0, 1], "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "tunnel": [0, 1], "cli": [0, 1], "start": 0, "help": 0, "usag": 0, "instruct": 0, "sourc": 0, "from": [0, 1], "an": 0, "env": [0, 1], "file": [0, 1], "By": 0, "default": 0, "look": 0, "current": 0, "work": 0, "directori": 0, "refer": [0, 1], "sampl": 0, "exampl": 0, "port": 0, "number": 0, "expos": 0, "host": 0, "hostnam": 0, "server": 0, "ha": [0, 1], "_": 0, "auth": [0, 1], "token": [0, 1], "configur": [0, 1], "filepath": 0, "auto": 0, "creat": [0, 1], "when": 0, "i": [0, 1], "specifi": 0, "distribut": [0, 1], "requir": 0, "updat": [0, 1], "exist": [0, 1], "new": [0, 1], "debug": 0, "boolean": 0, "flag": 0, "enabl": 0, "level": 0, "log": [0, 1], "profil": 0, "name": [0, 1], "access": 0, "kei": 0, "secret": 0, "region": 0, "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": [0, 1], "pytest": 0, "gener": 0, "valid": [0, 1], "hyperlink": 0, "all": 0, "markdown": 0, "includ": 0, "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "distribution_handl": 1, "public_url": 1, "str": 1, "env_dump": 1, "dict": 1, "none": 1, "process": 1, "paramet": 1, "public": 1, "url": 1, "json": 1, "dump": 1, "writer": 1, "frame": 1, "extract": 1, "messag": 1, "part": 1, "each": 1, "line": 1, "custom": 1, "kwarg": 1, "class": 1, "object": 1, "get": 1, "avail": 1, "otherwis": 1, "get_distribut": 1, "return": 1, "inform": 1, "type": 1, "create_distribut": 1, "yaml": 1, "config": 1, "update_distribut": 1, "origin_nam": 1, "origin": 1, "replac": 1, "addprocessnam": 1, "process_nam": 1, "wrapper": 1, "overrid": 1, "filter": 1, "add": 1, "processnam": 1, "take": 1, "ad": 1, "argument": 1, "record": 1, "logrecord": 1, "bool": 1, "built": 1, "build_logg": 1, "construct": 1, "concurr": 1, "basemodel": 1, "load": 1, "multiprocess": 1, "cloudfront_process": 1, "context": 1, "allow": 1, "arbitrari": 1, "arbitrary_types_allow": 1, "true": 1, "create_ngrok_config": 1, "filenam": 1, "env_load": 1, "o": 1, "pathlik": 1, "envconfig": 1, "base": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "run_valid": 1, "check": 1, "index": 1, "modul": 1, "search": 1}, "objects": {"nctl": [[1, 0, 0, "-", "cloudfront"], [1, 0, 0, "-", "logger"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "squire"]], "nctl.cloudfront": [[1, 1, 1, "", "CloudFront"]], "nctl.cloudfront.CloudFront": [[1, 2, 1, "", "create_distribution"], [1, 2, 1, "", "get_distribution"], [1, 2, 1, "", "run"], [1, 2, 1, "", "update_distribution"]], "nctl.logger": [[1, 1, 1, "", "AddProcessName"], [1, 3, 1, "", "build_logger"]], "nctl.logger.AddProcessName": [[1, 2, 1, "", "filter"]], "nctl.main": [[1, 3, 1, "", "distribution_handler"], [1, 3, 1, "", "tunnel"], [1, 3, 1, "", "writer"]], "nctl.models": [[1, 1, 1, "", "Concurrency"]], "nctl.models.Concurrency": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "cloudfront_process"]], "nctl.models.Concurrency.Config": [[1, 4, 1, "", "arbitrary_types_allowed"]], "nctl.squire": [[1, 3, 1, "", "create_ngrok_config"], [1, 3, 1, "", "env_loader"], [1, 3, 1, "", "run_validations"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"nctl": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "aw": 0, "config": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "cloudfront": 1, "logger": 1, "model": 1, "squir": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["NCTL", "Welcome to NCTL\u2019s documentation!"], "terms": {"fuse": 0, "ngrok": [0, 1], "cloudfront": 0, "offer": 0, "fulli": 0, "autom": 0, "solut": 0, "platform": 0, "support": 0, "deploy": 0, "recommend": 0, "instal": 0, "python": 0, "3": 0, "10": 0, "11": 0, "us": [0, 1], "dedic": [0, 1], "virtual": 0, "m": 0, "pip": 0, "initi": [0, 1], "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "tunnel": [0, 1], "cli": [0, 1], "start": 0, "help": 0, "usag": 0, "instruct": 0, "sourc": 0, "from": [0, 1], "an": 0, "env": [0, 1], "file": [0, 1], "By": 0, "default": 0, "look": 0, "current": 0, "work": 0, "directori": 0, "refer": [0, 1], "sampl": 0, "exampl": 0, "port": 0, "number": 0, "expos": 0, "host": 0, "hostnam": 0, "server": 0, "ha": [0, 1], "_": 0, "auth": [0, 1], "token": [0, 1], "configur": [0, 1], "filepath": 0, "auto": 0, "creat": [0, 1], "when": 0, "i": [0, 1], "specifi": 0, "distribut": [0, 1], "requir": 0, "updat": [0, 1], "exist": [0, 1], "new": [0, 1], "debug": 0, "boolean": 0, "flag": 0, "enabl": 0, "level": 0, "log": [0, 1], "profil": 0, "name": [0, 1], "access": 0, "kei": 0, "secret": 0, "region": 0, "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "t": 0, "pre": 0, "commit": 0, "ensur": 0, "run": [0, 1], "pytest": 0, "gener": 0, "valid": [0, 1], "hyperlink": 0, "all": 0, "markdown": 0, "includ": 0, "wiki": 0, "page": [0, 1], "sphinx": 0, "5": 0, "1": 0, "recommonmark": 0, "http": 0, "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "distribution_handl": 1, "public_url": 1, "str": 1, "env_dump": 1, "dict": 1, "none": 1, "process": 1, "paramet": 1, "public": 1, "url": 1, "json": 1, "dump": 1, "writer": 1, "frame": 1, "extract": 1, "messag": 1, "part": 1, "each": 1, "line": 1, "custom": 1, "kwarg": 1, "class": 1, "object": 1, "get": 1, "avail": 1, "otherwis": 1, "get_distribut": 1, "return": 1, "inform": 1, "type": 1, "create_distribut": 1, "yaml": 1, "config": 1, "update_distribut": 1, "origin_nam": 1, "origin": 1, "replac": 1, "addprocessnam": 1, "process_nam": 1, "wrapper": 1, "overrid": 1, "filter": 1, "add": 1, "processnam": 1, "take": 1, "ad": 1, "argument": 1, "record": 1, "logrecord": 1, "bool": 1, "built": 1, "build_logg": 1, "construct": 1, "concurr": 1, "basemodel": 1, "load": 1, "multiprocess": 1, "cloudfront_process": 1, "context": 1, "allow": 1, "arbitrari": 1, "arbitrary_types_allow": 1, "true": 1, "create_ngrok_config": 1, "filenam": 1, "env_load": 1, "o": 1, "pathlik": 1, "envconfig": 1, "base": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "run_valid": 1, "check": 1, "rais": 1, "assertionerror": 1, "If": 1, "ani": 1, "fail": 1, "index": 1, "modul": 1, "search": 1}, "objects": {"nctl": [[1, 0, 0, "-", "cloudfront"], [1, 0, 0, "-", "logger"], [1, 0, 0, "-", "main"], [1, 0, 0, "-", "squire"]], "nctl.cloudfront": [[1, 1, 1, "", "CloudFront"]], "nctl.cloudfront.CloudFront": [[1, 2, 1, "", "create_distribution"], [1, 2, 1, "", "get_distribution"], [1, 2, 1, "", "run"], [1, 2, 1, "", "update_distribution"]], "nctl.logger": [[1, 1, 1, "", "AddProcessName"], [1, 3, 1, "", "build_logger"]], "nctl.logger.AddProcessName": [[1, 2, 1, "", "filter"]], "nctl.main": [[1, 3, 1, "", "distribution_handler"], [1, 3, 1, "", "tunnel"], [1, 3, 1, "", "writer"]], "nctl.models": [[1, 1, 1, "", "Concurrency"]], "nctl.models.Concurrency": [[1, 1, 1, "", "Config"], [1, 4, 1, "", "cloudfront_process"]], "nctl.models.Concurrency.Config": [[1, 4, 1, "", "arbitrary_types_allowed"]], "nctl.squire": [[1, 3, 1, "", "create_ngrok_config"], [1, 3, 1, "", "env_loader"], [1, 3, 1, "", "run_validations"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"nctl": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "aw": 0, "config": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "cloudfront": 1, "logger": 1, "model": 1, "squir": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file