ohmyapi 0.2.5__tar.gz → 0.2.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/PKG-INFO +1 -1
  2. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/pyproject.toml +14 -1
  3. ohmyapi-0.2.8/src/ohmyapi/__init__.py +1 -0
  4. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/cli.py +8 -0
  5. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/runtime.py +19 -7
  6. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/scaffolding.py +22 -0
  7. ohmyapi-0.2.8/src/ohmyapi/core/templates/docker/Dockerfile +30 -0
  8. ohmyapi-0.2.8/src/ohmyapi/core/templates/docker/docker-compose.yml +7 -0
  9. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/project/pyproject.toml.j2 +1 -1
  10. ohmyapi-0.2.5/src/ohmyapi/__init__.py +0 -1
  11. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/README.md +0 -0
  12. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/__main__.py +0 -0
  13. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/auth/__init__.py +0 -0
  14. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/auth/models.py +0 -0
  15. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/auth/permissions.py +0 -0
  16. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/auth/routes.py +0 -0
  17. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/demo/__init__.py +0 -0
  18. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/demo/models.py +0 -0
  19. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/builtin/demo/routes.py +0 -0
  20. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/__init__.py +0 -0
  21. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/app/__init__.py.j2 +0 -0
  22. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/app/models.py.j2 +0 -0
  23. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/app/routes.py.j2 +0 -0
  24. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/project/README.md.j2 +0 -0
  25. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/core/templates/project/settings.py.j2 +0 -0
  26. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/db/__init__.py +0 -0
  27. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/db/exceptions.py +0 -0
  28. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/db/model/__init__.py +0 -0
  29. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/db/model/model.py +0 -0
  30. {ohmyapi-0.2.5 → ohmyapi-0.2.8}/src/ohmyapi/router.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ohmyapi
3
- Version: 0.2.5
3
+ Version: 0.2.8
4
4
  Summary: Django-flavored scaffolding and management layer around FastAPI, Pydantic, TortoiseORM and Aerich migrations
5
5
  License-Expression: MIT
6
6
  Keywords: fastapi,tortoise,orm,pydantic,async,web-framework
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "ohmyapi"
3
- version = "0.2.5"
3
+ version = "0.2.8"
4
4
  description = "Django-flavored scaffolding and management layer around FastAPI, Pydantic, TortoiseORM and Aerich migrations"
5
5
  license = "MIT"
6
6
  keywords = ["fastapi", "tortoise", "orm", "pydantic", "async", "web-framework"]
@@ -43,6 +43,19 @@ ohmyapi = "ohmyapi.cli:app"
43
43
  [project.urls]
44
44
  repository = "https://code.c-base.org/baccenfutter/ohmyapi"
45
45
 
46
+ [build-system]
47
+ requires = [
48
+ "poetry-core>=1.8.0",
49
+ "poetry-dynamic-versioning>=1.8.0"
50
+ ]
51
+ build-backend = "poetry_dynamic_versioning.backend"
52
+
53
+ [tool.poetry-dynamic-versioning]
54
+ enable = true
55
+ source = "file"
56
+ path = "src/ohmyapi/__init__.py"
57
+ pattern = "__VERSION__\\s*=\\s*['\"](?P<version>[^'\"]+)['\"]"
58
+
46
59
  [tool.black]
47
60
  line-length = 88
48
61
  target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
@@ -0,0 +1 @@
1
+ __VERSION__ = "0.2.8"
@@ -27,6 +27,12 @@ def startapp(app_name: str, root: str = "."):
27
27
  scaffolding.startapp(app_name, root)
28
28
 
29
29
 
30
+ @app.command()
31
+ def dockerize(root: str = "."):
32
+ """Create template Dockerfile and docker-compose.yml."""
33
+ scaffolding.copy_static("docker", root)
34
+
35
+
30
36
  @app.command()
31
37
  def serve(root: str = ".", host="127.0.0.1", port=8000):
32
38
  """
@@ -35,11 +41,13 @@ def serve(root: str = ".", host="127.0.0.1", port=8000):
35
41
  project_path = Path(root)
36
42
  project = runtime.Project(project_path)
37
43
  app_instance = project.app()
44
+ app_instance = project.configure_app(app_instance)
38
45
  uvicorn.run(app_instance, host=host, port=int(port), reload=False)
39
46
 
40
47
 
41
48
  @app.command()
42
49
  def shell(root: str = "."):
50
+ """An interactive shell with your loaded project runtime."""
43
51
  project_path = Path(root).resolve()
44
52
  project = runtime.Project(project_path)
45
53
 
@@ -72,23 +72,35 @@ class Project:
72
72
  def is_app_installed(self, name: str) -> bool:
73
73
  return name in getattr(self.settings, "INSTALLED_APPS", [])
74
74
 
75
- def app(self, generate_schemas: bool = False) -> FastAPI:
75
+ def app(self,
76
+ docs_url: str = "/docs",
77
+ ) -> FastAPI:
76
78
  """
77
- Create a FastAPI app, attach all APIRouters from registered apps,
78
- and register ORM lifecycle event handlers.
79
+ Create and return a FastAPI app.
79
80
  """
80
- app = FastAPI(title=getattr(self.settings, "PROJECT_NAME", "OhMyAPI Project"))
81
+ import ohmyapi
82
+ return FastAPI(
83
+ title=getattr(self.settings, "PROJECT_NAME", "OhMyAPI Project"),
84
+ description=getattr(self.settings, "PROJECT_DESCRIPTION", ""),
85
+ docs_url=getattr(self.settings, "DOCS_URL", "/docs"),
86
+ version=ohmyapi.__VERSION__,
87
+ )
81
88
 
82
- # Attach routers from apps
89
+ def configure_app(self, app: FastAPI) -> FastAPI:
90
+ """
91
+ Attach project routes and event handlers to given FastAPI instance.
92
+ """
93
+ # Attach project routes.
83
94
  for app_name, app_def in self._apps.items():
84
95
  for router in app_def.routers:
85
96
  app.include_router(router)
86
97
 
87
- # Startup / shutdown events
98
+ # Initialize ORM on startup
88
99
  @app.on_event("startup")
89
100
  async def _startup():
90
- await self.init_orm(generate_schemas=generate_schemas)
101
+ await self.init_orm(generate_schemas=False)
91
102
 
103
+ # Close ORM on shutdown
92
104
  @app.on_event("shutdown")
93
105
  async def _shutdown():
94
106
  await self.close_orm()
@@ -2,6 +2,8 @@ from pathlib import Path
2
2
 
3
3
  from jinja2 import Environment, FileSystemLoader
4
4
 
5
+ import shutil
6
+
5
7
  # Base templates directory
6
8
  TEMPLATE_DIR = Path(__file__).parent / "templates"
7
9
  env = Environment(loader=FileSystemLoader(str(TEMPLATE_DIR)))
@@ -53,6 +55,26 @@ def render_template_dir(
53
55
  render_template_file(template_dir / template_rel_path, context, output_path)
54
56
 
55
57
 
58
+ def copy_static(dir_name: str, target_dir: Path):
59
+ """Statically copy all files from {TEMPLATE_DIR}/{dir_name} to target_dir."""
60
+ template_dir = TEMPLATE_DIR / dir_name
61
+ target_dir = Path(target_dir)
62
+ if not template_dir.exists():
63
+ print(f"no templates found under: {dir_name}")
64
+ return
65
+
66
+ for root, _, files in template_dir.walk():
67
+ root_path = Path(root)
68
+ for file in files:
69
+ src = root_path / file
70
+ dst = target_dir / file
71
+ if dst.exists():
72
+ print(f"⛔ File exists, skipping: {dst}")
73
+ continue
74
+ shutil.copy(src, ".")
75
+ print(f"✅ Templates created successfully.")
76
+ print(f"🔧 Next, run `docker compose up -d --build`")
77
+
56
78
  def startproject(name: str):
57
79
  """Create a new project: flat structure, all project templates go into <name>/"""
58
80
  target_dir = Path(name).resolve()
@@ -0,0 +1,30 @@
1
+ FROM python:3.13-alpine
2
+
3
+ ENV PYTHONDONTWRITEBYTECODE=1 \
4
+ PYTHONUNBUFFERED=1 \
5
+ POETRY_HOME="/opt/poetry" \
6
+ POETRY_VIRTUALENVS_IN_PROJECT=true \
7
+ POETRY_NO_INTERACTION=1
8
+
9
+ RUN apk add --no-cache \
10
+ build-base \
11
+ curl \
12
+ git \
13
+ bash \
14
+ libffi-dev \
15
+ openssl-dev \
16
+ python3-dev \
17
+ musl-dev
18
+
19
+ RUN curl -sSL https://install.python-poetry.org | python3 -
20
+ ENV PATH="$POETRY_HOME/bin:$PATH"
21
+
22
+ WORKDIR /app
23
+ COPY pyproject.toml poetry.lock* /app/
24
+ RUN poetry lock
25
+ RUN poetry install
26
+ COPY . /app
27
+
28
+ EXPOSE 8000
29
+
30
+ CMD ["poetry", "run", "ohmyapi", "serve", "--host", "0.0.0.0"]
@@ -0,0 +1,7 @@
1
+ services:
2
+ app:
3
+ build:
4
+ context: .
5
+ restart: unless-stopped
6
+ ports:
7
+ - 8000:8000
@@ -10,7 +10,7 @@ readme = "README.md"
10
10
  license = { text = "MIT" }
11
11
 
12
12
  dependencies = [
13
- "ohmyapi (>=0.1.0,<0.2.0)"
13
+ "ohmyapi"
14
14
  ]
15
15
 
16
16
  [tool.poetry.group.dev.dependencies]
@@ -1 +0,0 @@
1
- from . import db
File without changes
File without changes
File without changes