ohmyapi 0.2.5__py3-none-any.whl → 0.2.8__py3-none-any.whl

ohmyapi/__init__.py

@@ -1 +1 @@
-from . import db
+__VERSION__ = "0.2.8"

ohmyapi/cli.py

@@ -27,6 +27,12 @@ def startapp(app_name: str, root: str = "."):
     scaffolding.startapp(app_name, root)
 
 
+@app.command()
+def dockerize(root: str = "."):
+    """Create template Dockerfile and docker-compose.yml."""
+    scaffolding.copy_static("docker", root)
+
+
 @app.command()
 def serve(root: str = ".", host="127.0.0.1", port=8000):
     """
@@ -35,11 +41,13 @@ def serve(root: str = ".", host="127.0.0.1", port=8000):
     project_path = Path(root)
     project = runtime.Project(project_path)
     app_instance = project.app()
+    app_instance = project.configure_app(app_instance)
     uvicorn.run(app_instance, host=host, port=int(port), reload=False)
 
 
 @app.command()
 def shell(root: str = "."):
+    """An interactive shell with your loaded project runtime."""
     project_path = Path(root).resolve()
     project = runtime.Project(project_path)
 

ohmyapi/core/runtime.py

@@ -72,23 +72,35 @@ class Project:
     def is_app_installed(self, name: str) -> bool:
         return name in getattr(self.settings, "INSTALLED_APPS", [])
 
-    def app(self, generate_schemas: bool = False) -> FastAPI:
+    def app(self,
+            docs_url: str = "/docs",
+    ) -> FastAPI:
         """
-        Create a FastAPI app, attach all APIRouters from registered apps,
-        and register ORM lifecycle event handlers.
+        Create and return a FastAPI app.
         """
-        app = FastAPI(title=getattr(self.settings, "PROJECT_NAME", "OhMyAPI Project"))
+        import ohmyapi
+        return FastAPI(
+            title=getattr(self.settings, "PROJECT_NAME", "OhMyAPI Project"),
+            description=getattr(self.settings, "PROJECT_DESCRIPTION", ""),
+            docs_url=getattr(self.settings, "DOCS_URL", "/docs"),
+            version=ohmyapi.__VERSION__,
+        )
 
-        # Attach routers from apps
+    def configure_app(self, app: FastAPI) -> FastAPI:
+        """
+        Attach project routes and event handlers to given FastAPI instance.
+        """
+        # Attach project routes.
         for app_name, app_def in self._apps.items():
             for router in app_def.routers:
                 app.include_router(router)
 
-        # Startup / shutdown events
+        # Initialize ORM on startup
         @app.on_event("startup")
         async def _startup():
-            await self.init_orm(generate_schemas=generate_schemas)
+            await self.init_orm(generate_schemas=False)
 
+        # Close ORM on shutdown
         @app.on_event("shutdown")
         async def _shutdown():
             await self.close_orm()

ohmyapi/core/scaffolding.py

@@ -2,6 +2,8 @@ from pathlib import Path
 
 from jinja2 import Environment, FileSystemLoader
 
+import shutil
+
 # Base templates directory
 TEMPLATE_DIR = Path(__file__).parent / "templates"
 env = Environment(loader=FileSystemLoader(str(TEMPLATE_DIR)))
@@ -53,6 +55,26 @@ def render_template_dir(
             render_template_file(template_dir / template_rel_path, context, output_path)
 
 
+def copy_static(dir_name: str, target_dir: Path):
+    """Statically copy all files from {TEMPLATE_DIR}/{dir_name} to target_dir."""
+    template_dir = TEMPLATE_DIR / dir_name
+    target_dir = Path(target_dir)
+    if not template_dir.exists():
+        print(f"no templates found under: {dir_name}")
+        return
+
+    for root, _, files in template_dir.walk():
+        root_path = Path(root)
+        for file in files:
+            src = root_path / file
+            dst = target_dir / file
+            if dst.exists():
+                print(f"⛔ File exists, skipping: {dst}")
+                continue
+            shutil.copy(src, ".")
+    print(f"✅ Templates created successfully.")
+    print(f"🔧 Next, run `docker compose up -d --build`")
+
 def startproject(name: str):
     """Create a new project: flat structure, all project templates go into <name>/"""
     target_dir = Path(name).resolve()

ohmyapi/core/templates/docker/Dockerfile

@@ -0,0 +1,30 @@
+FROM python:3.13-alpine
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    POETRY_HOME="/opt/poetry" \
+    POETRY_VIRTUALENVS_IN_PROJECT=true \
+    POETRY_NO_INTERACTION=1
+
+RUN apk add --no-cache \
+    build-base \
+    curl \
+    git \
+    bash \
+    libffi-dev \
+    openssl-dev \
+    python3-dev \
+    musl-dev
+
+RUN curl -sSL https://install.python-poetry.org | python3 -
+ENV PATH="$POETRY_HOME/bin:$PATH"
+
+WORKDIR /app
+COPY pyproject.toml poetry.lock* /app/
+RUN poetry lock
+RUN poetry install
+COPY . /app
+
+EXPOSE 8000
+
+CMD ["poetry", "run", "ohmyapi", "serve", "--host", "0.0.0.0"]

ohmyapi/core/templates/docker/docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  app:
+    build:
+      context: .
+    restart: unless-stopped
+    ports:
+      - 8000:8000

ohmyapi/core/templates/project/pyproject.toml.j2

@@ -10,7 +10,7 @@ readme = "README.md"
 license = { text = "MIT" }
 
 dependencies = [
-    "ohmyapi (>=0.1.0,<0.2.0)"
+    "ohmyapi"
 ]
 
 [tool.poetry.group.dev.dependencies]

{ohmyapi-0.2.5.dist-info → ohmyapi-0.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.2.5
+Version: 0.2.8
 Summary: Django-flavored scaffolding and management layer around FastAPI, Pydantic, TortoiseORM and Aerich migrations
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,pydantic,async,web-framework

{ohmyapi-0.2.5.dist-info → ohmyapi-0.2.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ohmyapi/__init__.py,sha256=3y8knoHhOjkUMMi7ADheYxBJywXPvpn5JldxMUeWejw,17
+ohmyapi/__init__.py,sha256=bIBn6BOvT5PCbHYDKzeSJwZgEWeSlQA2KfNoH5rKYbE,22
 ohmyapi/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
 ohmyapi/builtin/auth/__init__.py,sha256=vOVCSJX8BALzs8h5ZW9507bjoscP37bncMjdMmBXcMM,42
 ohmyapi/builtin/auth/models.py,sha256=8az4TKdC6PUha3_HyslKinDT2-yAN-aBoYUQcjxm7Js,1728
@@ -7,22 +7,24 @@ ohmyapi/builtin/auth/routes.py,sha256=r887BWea20vinX88QBuxGzQc9BrIi-LqyStM0V1cl1
 ohmyapi/builtin/demo/__init__.py,sha256=44Yo3mYmlKSKEwVp6O9urr-C_3qDQzCYLMn6B9i6wew,29
 ohmyapi/builtin/demo/models.py,sha256=r06rfuhPJaI2fYsQ24L1JCOd67f2GQNfGnkgKAptOX8,1404
 ohmyapi/builtin/demo/routes.py,sha256=1VTlEttrez6Qnhrz_9sTA-emtfXem0s0BkPVcLvg3k0,1801
-ohmyapi/cli.py,sha256=dJVNgpW5S4rCc619AEEKBKuEIAmQs153Ls0ZVaea48w,4173
+ohmyapi/cli.py,sha256=gHiPWN3pkrrIJ69WFBHt0BTRNVI-YSJD7VhtqQRwKuc,4447
 ohmyapi/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ohmyapi/core/runtime.py,sha256=Zs2080IXOamzs1TIRVCX-oWh93uJHumtYUwMZKtRwFY,11958
-ohmyapi/core/scaffolding.py,sha256=SA0SYFd7VcqkOn9xuXgj-yOoVqCZMJo68GGFbm34GE4,2663
+ohmyapi/core/runtime.py,sha256=pNfFRk7sFX8FePX6cnb4H7kLh5CauNnA_gmc0rsWIh8,12287
+ohmyapi/core/scaffolding.py,sha256=1KF67aBvd08xjDhIXhI-nDhClJAw2TB3tYVLiMmeYOk,3426
 ohmyapi/core/templates/app/__init__.py.j2,sha256=QwVIQVUGZVhdH1d4NrvL7NTsK4-T4cihzYs8UVX2dt4,43
 ohmyapi/core/templates/app/models.py.j2,sha256=_3w-vFJ5fgsmncsCv34k_wyCMF78jufbSSglns4gbb0,119
 ohmyapi/core/templates/app/routes.py.j2,sha256=SxLz_wvakusj5txbXToZyNq6ZmcamSwNjVrI0MNPRl0,1037
+ohmyapi/core/templates/docker/Dockerfile,sha256=4-QgqK6h9sR7hYKGUvRife6GpLTm7EOzYupr54B3qUY,596
+ohmyapi/core/templates/docker/docker-compose.yml,sha256=Jr344DALp28_w9d9O-HIuQgwaacIHabyFyvBuOQ-PeQ,102
 ohmyapi/core/templates/project/README.md.j2,sha256=SjR4JIrg-8XRE-UntUDwiw8jDpYitD_UjwoKkYJ7GLw,22
-ohmyapi/core/templates/project/pyproject.toml.j2,sha256=3ZqO6FX9Bhq8OAZl8nHPXCiWxl3gAffIF-LsC_-K9Us,538
+ohmyapi/core/templates/project/pyproject.toml.j2,sha256=D3d5yv2317owH3tFYN6klMavt74gTqqhDsHe0jhqUeA,521
 ohmyapi/core/templates/project/settings.py.j2,sha256=So6w1OiL_jU-FyeT8IHueDjGNuEoSkYhabhHpne2fUU,140
 ohmyapi/db/__init__.py,sha256=5QKUycxnN83DOUD_Etoee9tEOYjnZ74deqrSOOx_MiQ,204
 ohmyapi/db/exceptions.py,sha256=vb4IIUoeYAY6sK42zRtjMy-39IFVi_Qb6mWySTY0jYw,34
 ohmyapi/db/model/__init__.py,sha256=k3StTNuKatpwZo_Z5JBFa-927eJrzibFE8U4SA82asc,32
 ohmyapi/db/model/model.py,sha256=ui4g78c5xoS06Dj8Cdk7QgTjRnE68zKeL-AdmeYYPuQ,2776
 ohmyapi/router.py,sha256=5g0U59glu4hxxnIoTSFzb2S2offkOT3eE39aprzVxwo,83
-ohmyapi-0.2.5.dist-info/METADATA,sha256=lZw4-WY9rahDJboBp1q0RNAxrzErYkA7p3lnz4RyVYo,2575
-ohmyapi-0.2.5.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
-ohmyapi-0.2.5.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
-ohmyapi-0.2.5.dist-info/RECORD,,
+ohmyapi-0.2.8.dist-info/METADATA,sha256=ww_6H1sYKecjuCvYSStN8Ql01xqDY0MINAetvtrHQJo,2575
+ohmyapi-0.2.8.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ohmyapi-0.2.8.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
+ohmyapi-0.2.8.dist-info/RECORD,,

{ohmyapi-0.2.5.dist-info → ohmyapi-0.2.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.2.0
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any