Allow logging.ini for custom logger setup

Author: dormant-user

.gitignore

@@ -11,3 +11,8 @@ PyNinja.egg-info/
 doc_gen/_*
 
 temp.py
+
+# work in progress
+samples/
+logging.ini
+*.log

docs/index.html

@@ -68,6 +68,11 @@ <h1>Welcome to PyNinja’s documentation!<a class="headerlink" href="#welcome-to
 <dt class="sig sig-object py" id="pyninja.main.start">
 <span class="sig-prename descclassname"><span class="pre">pyninja.main.</span></span><span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyninja.main.start" title="Permalink to this definition">¶</a></dt>
 <dd><p>Starter function for the API, which uses uvicorn server as trigger.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>env_file</strong> – Filepath for the <code class="docutils literal notranslate"><span class="pre">.env</span></code> file.</p>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

docs/searchindex.js

@@ -4,9 +4,7 @@
 
 import click
 
-from pyninja.main import start  # noqa: F401
-
-version = "0.0.0"
+from pyninja.main import start, version  # noqa: F401
 
 
 @click.command()

pyninja/__init__.py

@@ -1,24 +1,34 @@
 import os
-import platform
 
 import uvicorn
 from fastapi import FastAPI
 
 from pyninja import routers, squire
 
+version = "0.0.0"
+
 
 def start(env_file: str = None) -> None:
-    """Starter function for the API, which uses uvicorn server as trigger."""
+    """Starter function for the API, which uses uvicorn server as trigger.
+
+    Args:
+        env_file: Filepath for the ``.env`` file.
+    """
     squire.env = squire.env_loader(
         env_file or os.environ.get("env_file") or os.environ.get("ENV_FILE") or ".env"
     )
     app = FastAPI(
         routes=routers.routes,
-        title=f"Service monitor for {platform.uname().node}",
+        title="PyNinja",
+        description="Light weight OS agnostic service monitoring API",
+        version=version,
     )
-    uvicorn.run(
+    kwargs = dict(
         host=squire.env.ninja_host,
         port=squire.env.ninja_port,
         workers=squire.env.workers,
         app=app,
     )
+    if os.path.isfile("logging.ini"):
+        kwargs["log_config"] = os.path.join(os.getcwd(), "logging.ini")
+    uvicorn.run(**kwargs)

pyninja/main.py

@@ -6,8 +6,7 @@
 
 from pyninja import auth, exceptions, service, squire
 
-logging.getLogger("uvicorn.access").disabled = True
-LOGGER = logging.getLogger("uvicorn.error")
+LOGGER = logging.getLogger("uvicorn")
 
 
 async def service_status(payload: squire.StatusPayload):

pyninja/routers.py

@@ -0,0 +1 @@
+VERSION = "0.0.0"