Restructure project

Author: dormant-user

.github/workflows/python-publish.yml

@@ -2,10 +2,7 @@ name: pypi-publish
 
 on:
   release:
-    types: [
-      "published",
-      "edited",
-    ]
+    types: [ published ]
   workflow_dispatch:
 
 jobs:

.gitignore

@@ -4,4 +4,4 @@ venv
 dist/
 .DS_Store
 __pycache__/
-FastAPIAuthenticator.egg-info/
+FastAPI_UI_Auth.egg-info/

README.md

@@ -1,4 +1,4 @@
-# FastAPIAuthenticator
+# FastAPIUIAuth
 
 Python module to add username and password authentication to specific FastAPI routes
 
@@ -8,20 +8,24 @@ Python module to add username and password authentication to specific FastAPI ro
 
 ![Platform][label-platform]
 
-## Installation
+**Deployments**
 
-```shell
-repo="thevickypedia/FastAPIAuthenticator"
+[![pypi][label-actions-pypi]][gha_pypi]
 
-latest=$(curl -s https://api.github.com/repos/${repo}/tags | jq -r '.[0].name')
+[![Pypi][label-pypi]][pypi]
+[![Pypi-format][label-pypi-format]][pypi-files]
+[![Pypi-status][label-pypi-status]][pypi]
 
-pip install "git+https://github.com/${repo}.git@${latest}"
+## Installation
+
+```shell
+pip install FastAPI-UI-Auth
 ```
 
 ## Usage
 
 ```python
-import fastapiauthenticator as api
+import uiauth
 
 from fastapi import FastAPI
 
@@ -34,16 +38,16 @@ async def public_route():
 async def private_route():
     return {"message": "This is a private route"}
 
-api.protect(
+uiauth.protect(
     app=app,
-    params=api.Parameters(
+    params=uiauth.Parameters(
         path="/private",
         function=private_route
     )
 )
 ```
 
-> `FastAPIAuthenticator` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
+> `FastAPI-UI-Auth` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
 > Refer [samples] directory for different use-cases.
 
 ## Coding Standards
@@ -73,6 +77,11 @@ python -m pip install sphinx==5.1.1 pre-commit recommonmark
 pre-commit run --all-files
 ```
 
+## Pypi Package
+[![pypi-module][label-pypi-package]][pypi-repo]
+
+[https://pypi.org/project/FastAPI-UI-Auth/][pypi]
+
 ## License & copyright
 
 &copy; Vignesh Rao
@@ -82,12 +91,23 @@ Licensed under the [MIT License][license]
 [//]: # (Labels)
 
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
-[license]: https://github.com/thevickypedia/FastAPIAuthenticator/blob/main/LICENSE
+[license]: https://github.com/thevickypedia/FastAPI-UI-Auth/blob/main/LICENSE
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
-[samples]: https://github.com/thevickypedia/FastAPIAuthenticator/tree/main/samples
+[samples]: https://github.com/thevickypedia/FastAPI-UI-Auth/tree/main/samples
 
+[label-actions-pypi]: https://github.com/thevickypedia/FastAPI-UI-Auth/actions/workflows/python-publish.yml/badge.svg
+[label-pypi]: https://img.shields.io/pypi/v/FastAPI-UI-Auth
+[label-pypi-format]: https://img.shields.io/pypi/format/FastAPI-UI-Auth
+[label-pypi-status]: https://img.shields.io/pypi/status/FastAPI-UI-Auth
+[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-FastAPI-UI-Auth-blue?style=for-the-badge&logo=Python
 [label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
-[release-notes]: https://github.com/thevickypedia/FastAPIAuthenticator/blob/main/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/FastAPI-UI-Auth/blob/main/release_notes.rst
+
+[gha_pypi]: https://github.com/thevickypedia/FastAPI-UI-Auth/actions/workflows/python-publish.yml
+
+[pypi]: https://pypi.org/project/FastAPI-UI-Auth
+[pypi-files]: https://pypi.org/project/FastAPI-UI-Auth/#files
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

fastapiauthenticator/__init__.py

@@ -6,13 +6,13 @@ readme = "README.md"
 requires-python = ">=3.11"
 
 [tool.setuptools]
-packages = ["fastapiauthenticator", "fastapiauthenticator.templates"]
+packages = ["uiauth", "uiauth.templates"]
 [tool.setuptools.package-data]
-"fastapiauthenticator.templates" = ["*.html"]
+"uiauth.templates" = ["*.html"]
 
 [tool.setuptools.dynamic]
 dependencies = { file = ["requirements.txt"] }
-version = { attr = "fastapiauthenticator.version.version" }
+version = { attr = "uiauth.version.version" }
 
 [project.optional-dependencies]
 dev = [

pyproject.toml

@@ -18,7 +18,7 @@ v0.0.1 (06/22/2025)
 -------------------
 - Create a base python module to enable ``username``/``password`` authentication for any specific route
 - Transmits ``username`` and ``password`` securely by encrypting ``credentials`` → ``hex`` → ``hash + timestamp``
-- Includes basic UI templates for login
+- Includes basic templates for UI authentication
 - **Full Changelog**: https://github.com/thevickypedia/FastAPIAuthenticator/compare/v0.0.0-a...v0.0.1
 
 v0.0.0-a (06/21/2025)

release_notes.rst

@@ -4,7 +4,7 @@
 from fastapi.responses import HTMLResponse, JSONResponse, RedirectResponse
 from fastapi.routing import APIRoute
 
-import fastapiauthenticator as auth
+import uiauth
 
 
 def root_page() -> RedirectResponse:
@@ -38,9 +38,9 @@ def secure_function(_: Request) -> HTMLResponse:
         ),
     ]
 )
-auth.protect(
+uiauth.protect(
     app=app,
-    params=auth.Parameters(
+    params=uiauth.Parameters(
         path="/sensitive-data",
         function=secure_function,
     ),

samples/sample1.py

@@ -5,7 +5,7 @@
 from fastapi.responses import FileResponse, HTMLResponse
 from fastapi.routing import APIWebSocketRoute
 
-import fastapiauthenticator as auth
+import uiauth
 
 app = FastAPI()
 
@@ -81,18 +81,18 @@ async def send_wave_command(command: str):
     return {"status": f"Command '{command}' sent."}
 
 
-auth.protect(
+uiauth.protect(
     app=app,
     params=[
-        auth.Parameters(
+        uiauth.Parameters(
             function=get_siriwave_js,
             path="/siriwave.js",
         ),
-        auth.Parameters(
+        uiauth.Parameters(
             function=index,
             path="/",
         ),
-        auth.Parameters(
+        uiauth.Parameters(
             function=websocket_endpoint,
             route=APIWebSocketRoute,
             path="/ws",

samples/sample2.py

@@ -0,0 +1,6 @@
+from uiauth.enums import APIEndpoints, APIMethods  # noqa: F401,E402
+from uiauth.models import Parameters  # noqa: F401,E402
+from uiauth.service import FastAPIUIAuth  # noqa: F401,E402
+from uiauth.version import version  # noqa: F401,E402
+
+protect = FastAPIUIAuth

uiauth/__init__.py

@@ -1,8 +1,8 @@
 from fastapi.requests import Request
 from fastapi.responses import HTMLResponse
 
-from fastapiauthenticator import enums, models, utils
-from fastapiauthenticator.version import version
+from uiauth import enums, models, utils
+from uiauth.version import version
 
 
 def session(request: Request) -> HTMLResponse: