Adapt PyNinja naming project-wide

README.md

@@ -1,2 +1,2 @@
-# service-monitor
-Service monitor for Linux and macOS
+# PyNinja
+Light weight OS agnostic service monitoring API

monitor/__init__.py → pyninja/__init__.py

@@ -4,7 +4,7 @@
 
 import click
 
-from monitor.main import start  # noqa: F401
+from pyninja.main import start  # noqa: F401
 
 version = "0.0.0-a"
 
@@ -21,7 +21,7 @@
     help="Environment configuration filepath.",
 )
 def commandline(*args, **kwargs) -> None:
-    """Starter function to invoke service-monitor via CLI commands.
+    """Starter function to invoke PyNinja via CLI commands.
 
     **Flags**
         - ``--version | -V``: Prints the version.
@@ -46,7 +46,7 @@ def commandline(*args, **kwargs) -> None:
         for k, v in options.items()
     )
     if kwargs.get("version"):
-        click.echo(f"service-monitor {version}")
+        click.echo(f"PyNinja {version}")
         sys.exit(0)
     if kwargs.get("help"):
         click.echo(

monitor/auth.py → pyninja/auth.py

@@ -4,7 +4,7 @@
 from fastapi import Depends
 from fastapi.security import HTTPBasicCredentials, HTTPBearer
 
-from monitor import exceptions, squire
+from pyninja import exceptions, squire
 
 SECURITY = HTTPBearer()
 

monitor/main.py → pyninja/main.py

@@ -4,7 +4,7 @@
 import uvicorn
 from fastapi import FastAPI
 
-from monitor import router, squire
+from pyninja import router, squire
 
 
 def start(env_file: str = None) -> None:

monitor/router.py → pyninja/router.py

@@ -4,13 +4,13 @@
 from fastapi.responses import RedirectResponse
 from fastapi.routing import APIRoute
 
-from monitor import auth, exceptions, service
+from pyninja import auth, exceptions, service
 
 logging.getLogger("uvicorn.access").disabled = True
 LOGGER = logging.getLogger("uvicorn.error")
 
 
-async def service_monitor(service_name: str):
+async def service_status(service_name: str):
     """API function to monitor a service."""
     service_status = service.get_service_status(service_name)
     LOGGER.info(
@@ -32,8 +32,8 @@ async def docs():
 
 routes = [
     APIRoute(
-        path="/service-monitor",
-        endpoint=service_monitor,
+        path="/status",
+        endpoint=service_status,
         methods=["GET"],
         dependencies=[Depends(auth.authenticator)],
     ),

monitor/service.py → pyninja/service.py

@@ -4,7 +4,7 @@
 
 import psutil
 
-from monitor import exceptions, squire
+from pyninja import exceptions, squire
 
 current_os = platform.system()
 

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "PyNinja"
 dynamic = ["version", "dependencies"]
-description = "OS agnostic service monitoring API"
+description = "Light weight OS agnostic service monitoring API"
 readme = "README.md"
 authors = [{ name = "Vignesh Rao", email = "[email protected]" }]
 license = { file = "LICENSE" }
@@ -12,31 +12,32 @@ classifiers = [
     "Operating System :: MacOS :: MacOS X",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX :: Linux",
+    "Topic :: System :: Monitoring",
 ]
-keywords = ["service-monitor"]
+keywords = ["service-monitor", "PyNinja"]
 requires-python = ">=3.10"
 
 [tool.setuptools]
 packages = ["monitor"]
 
 [tool.setuptools.dynamic]
-version = {attr = "monitor.version"}
+version = {attr = "pyninja.version"}
 dependencies = { file = ["requirements.txt"] }
 
 [project.optional-dependencies]
 dev = ["sphinx==5.1.1", "pre-commit", "recommonmark", "gitverse"]
 
 [project.scripts]
 # sends all the args to commandline function, where the arbitary commands as processed accordingly
-monitor = "monitor:commandline"
+pyninja = "pyninja:commandline"
 
 [build-system]
 requires      = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project.urls]
-Homepage = "https://github.com/thevickypedia/service-monitor"
-Docs = "https://thevickypedia.github.io/service-monitor"
-Source = "https://github.com/thevickypedia/service-monitor"
-"Bug Tracker" = "https://github.com/thevickypedia/service-monitor/issues"
-"Release Notes" = "https://github.com/thevickypedia/service-monitor/blob/main/release_notes.rst"
+Homepage = "https://github.com/thevickypedia/PyNinja"
+Docs = "https://thevickypedia.github.io/PyNinja"
+Source = "https://github.com/thevickypedia/PyNinja"
+"Bug Tracker" = "https://github.com/thevickypedia/PyNinja/issues"
+"Release Notes" = "https://github.com/thevickypedia/PyNinja/blob/main/release_notes.rst"