Add an option to set apikey via commandline argument

Add samples, and update runbook

.gitignore

@@ -12,7 +12,7 @@ doc_gen/_*
 
 temp.py
 
-# work in progress
-samples/
 logging.ini
 *.log
+
+!samples/*

README.md

@@ -58,6 +58,9 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **APIKEY** - API Key for authentication.
 
+> `PyNinja` supports [logging.ini] configuration for custom logging. Just place it in the current working directory.<br>
+> Refer [samples] directory for examples.
+
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
 Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
@@ -132,3 +135,5 @@ Licensed under the [MIT License][license]
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
 [license]: https://github.com/thevickypedia/PyNinja/blob/master/LICENSE
 [runbook]: https://thevickypedia.github.io/PyNinja/
+[samples]: https://github.com/thevickypedia/PyNinja/tree/main/samples
+[logging.ini]: https://docs.python-guide.org/writing/logging/#example-configuration-via-an-ini-file

docs/README.html

@@ -95,6 +95,10 @@ <h2>Environment Variables<a class="headerlink" href="#environment-variables" tit
 <li><p><strong>WORKERS</strong> - Number of workers for the uvicorn server.</p></li>
 <li><p><strong>APIKEY</strong> - API Key for authentication.</p></li>
 </ul>
+<blockquote>
+<div><p><code class="docutils literal notranslate"><span class="pre">PyNinja</span></code> supports <a class="reference external" href="https://docs.python-guide.org/writing/logging/#example-configuration-via-an-ini-file">logging.ini</a> configuration for custom logging. Just place it in the current working directory.<br>
+Refer <a class="reference external" href="https://github.com/thevickypedia/PyNinja/tree/main/samples">samples</a> directory for examples.</p>
+</div></blockquote>
 </section>
 <section id="coding-standards">
 <h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permalink to this heading">¶</a></h2>

docs/README.md

@@ -58,6 +58,9 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **APIKEY** - API Key for authentication.
 
+> `PyNinja` supports [logging.ini] configuration for custom logging. Just place it in the current working directory.<br>
+> Refer [samples] directory for examples.
+
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
 Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
@@ -132,3 +135,5 @@ Licensed under the [MIT License][license]
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
 [license]: https://github.com/thevickypedia/PyNinja/blob/master/LICENSE
 [runbook]: https://thevickypedia.github.io/PyNinja/
+[samples]: https://github.com/thevickypedia/PyNinja/tree/main/samples
+[logging.ini]: https://docs.python-guide.org/writing/logging/#example-configuration-via-an-ini-file

docs/_sources/README.md.txt

@@ -58,6 +58,9 @@ pyninja start
 - **WORKERS** - Number of workers for the uvicorn server.
 - **APIKEY** - API Key for authentication.
 
+> `PyNinja` supports [logging.ini] configuration for custom logging. Just place it in the current working directory.<br>
+> Refer [samples] directory for examples.
+
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
 Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
@@ -132,3 +135,5 @@ Licensed under the [MIT License][license]
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
 [license]: https://github.com/thevickypedia/PyNinja/blob/master/LICENSE
 [runbook]: https://thevickypedia.github.io/PyNinja/
+[samples]: https://github.com/thevickypedia/PyNinja/tree/main/samples
+[logging.ini]: https://docs.python-guide.org/writing/logging/#example-configuration-via-an-ini-file

pyninja/__init__.py

@@ -1,17 +1,21 @@
 """Placeholder for packaging."""
 
+import os
 import sys
 
 import click
 
-from pyninja.main import start, version  # noqa: F401
+from pyninja.main import start  # noqa: F401
+
+version = "0.0.0"
 
 
 @click.command()
 @click.argument("start", required=False)
 @click.argument("run", required=False)
 @click.option("--version", "-V", is_flag=True, help="Prints the version.")
 @click.option("--help", "-H", is_flag=True, help="Prints the help section.")
+@click.option("--apikey", "-A", help="APIkey for the server.")
 @click.option(
     "--env",
     "-E",
@@ -24,6 +28,7 @@ def commandline(*args, **kwargs) -> None:
     **Flags**
         - ``--version | -V``: Prints the version.
         - ``--help | -H``: Prints the help section.
+        - ``--apikey | -A``: Takes the apikey as a commandline argument.
         - ``--env | -E``: Environment configuration filepath.
 
     **Commands**
@@ -33,6 +38,7 @@ def commandline(*args, **kwargs) -> None:
     options = {
         "--version | -V": "Prints the version.",
         "--help | -H": "Prints the help section.",
+        "--apikey | -A": "APIkey for the server.",
         "--env | -E": "Environment configuration filepath.",
         "start | run": "Initiates the backup process.",
     }
@@ -51,6 +57,8 @@ def commandline(*args, **kwargs) -> None:
             f"\nUsage: pyninja [arbitrary-command]\nOptions (and corresponding behavior):{choices}"
         )
         sys.exit(0)
+    if kwargs.get("apikey"):
+        os.environ["apikey"] = kwargs.get("apikey")
     trigger = kwargs.get("start") or kwargs.get("run")
     if trigger and trigger.lower() in ("start", "run"):
         # Click doesn't support assigning defaults like traditional dictionaries, so kwargs.get("max", 100) won't work

pyninja/main.py

@@ -3,10 +3,9 @@
 import uvicorn
 from fastapi import FastAPI
 
+import pyninja
 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.
@@ -21,7 +20,7 @@ def start(env_file: str = None) -> None:
         routes=routers.routes,
         title="PyNinja",
         description="Light weight OS agnostic service monitoring API",
-        version=version,
+        version=pyninja.version,
     )
     kwargs = dict(
         host=squire.env.ninja_host,

pyninja/routers.py

@@ -6,7 +6,7 @@
 
 from pyninja import auth, exceptions, service, squire
 
-LOGGER = logging.getLogger("uvicorn")
+LOGGER = logging.getLogger(__name__)
 
 
 async def service_status(payload: squire.StatusPayload):
@@ -39,7 +39,7 @@ async def docs():
 
 routes = [
     APIRoute(
-        path="/status",
+        path="/service-status",
         endpoint=service_status,
         methods=["POST"],
         dependencies=[Depends(auth.authenticator)],

requirements.txt

@@ -1,3 +1,4 @@
+click==8.1.7
 fastapi==0.112.0
 psutil==6.0.0
 pydantic==2.8.2

samples/.env

@@ -0,0 +1,4 @@
+NINJA_HOST="0.0.0.0"
+NINJA_PORT=8005
+APIKEY="MySecreatAccessToken"
+WORKERS=3

samples/README.md

@@ -0,0 +1,31 @@
+## Sample Environment Variables
+
+Environment variables can be sourced using any `plaintext` / `JSON` / `YAML` file.
+The filepath should be provided as an argument during object instantiation.
+
+⚠️ Sample values are randomly generated strings from https://pinetools.com/random-string-generator
+
+> By default, `PyNinja` will look for a `.env` file in the current working directory.
+
+### Examples
+
+- PlainText: [.env]
+- JSON: [secrets.json]
+- YAML: [secrets.yaml]
+
+[.env]: .env
+[secrets.json]: secrets.json
+[secrets.yaml]: secrets.yaml
+
+### Usage
+
+- **CLI**
+```shell
+pyninja --env "/path/to/env/file" start
+```
+
+- **IDE**
+```python
+import pyninja
+pyninja.start(env_file='/path/to/env/file')
+```

samples/logging.ini

@@ -0,0 +1,27 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=logfile,logconsole
+
+[formatters]
+keys=logformatter
+
+[logger_root]
+level=INFO
+handlers=logfile, logconsole
+
+[formatter_logformatter]
+format=[%(asctime)s.%(msecs)03d] %(levelname)s [%(thread)d] - %(message)s
+
+[handler_logfile]
+class=handlers.RotatingFileHandler
+level=INFO
+args=('logfile.log','a')
+formatter=logformatter
+
+[handler_logconsole]
+class=handlers.logging.StreamHandler
+level=INFO
+args=()
+formatter=logformatter

samples/secrets.json

@@ -0,0 +1,6 @@
+{
+    "NINJA_HOST": "0.0.0.0",
+    "NINJA_PORT": 8005,
+    "APIKEY": "MySecreatAccessToken",
+    "WORKERS": 3
+}

samples/secrets.yaml

@@ -0,0 +1,4 @@
+APIKEY: MySecreatAccessToken
+NINJA_HOST: 0.0.0.0
+NINJA_PORT: 8005
+WORKERS: 3