obox-builder 1.0.2__tar.gz

obox_builder-1.0.2/.gitignore

@@ -0,0 +1,32 @@
+*.pyc
+env*
+.mypy_cache
+.vscode
+.idea
+.venv
+poetry.lock
+dist
+htmlcov
+*.egg-info
+.coverage*
+coverage.xml
+site
+*.db
+*.db-wal
+*.db-shm
+*.sqlite
+.cache
+__pycache__/
+.pytest_cache/
+upload*/
+CLAUDE.md
+.DS_Store
+
+docs/locales/*/content/assets/
+docs/locales/*/content/javascripts/
+docs/locales/*/content/stylesheets/
+docs/locales/*/content/changelog.md
+docs/locales/*/content/community.md
+docs/locales/*/content/blog/.authors.yml
+
+zensical.*.toml

obox_builder-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jocelin Hounon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

obox_builder-1.0.2/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.5
+Name: obox-builder
+Version: 1.0.2
+Summary: Fast, beautiful and extensible administrative interface framework for FastAPI & Starlette applications
+Project-URL: Homepage, https://github.com/vinhgiga/obox-builder
+Project-URL: Documentation, https://vinhgiga.github.io/obox-builder
+Project-URL: Repository, https://github.com/vinhgiga/obox-builder
+Project-URL: Changelog, https://vinhgiga.github.io/obox-builder/changelog/
+Project-URL: Upstream, https://github.com/jowilf/starlette-admin
+Author: vinhgiga
+License-Expression: MIT
+License-File: LICENSE
+Keywords: admin,admin-dashboard,admin-panel,asgi,beanie,crud,dashboard,fastapi,mongodb,mongoengine,odm,orm,sqlalchemy,sqlmodel,starlette,tortoise-orm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: itsdangerous<2.3.0,>=2.2.0
+Requires-Dist: jinja2<4.0.0,>=3.0.0
+Requires-Dist: python-multipart>=0.0.18
+Requires-Dist: starlette>=0.40.0
+Provides-Extra: email
+Requires-Dist: email-validator>=2.0.0; extra == 'email'
+Provides-Extra: i18n
+Requires-Dist: babel>=2.17.0; extra == 'i18n'
+Provides-Extra: pdf
+Requires-Dist: reportlab>=4.5.1; extra == 'pdf'
+Provides-Extra: s3
+Requires-Dist: aiobotocore>=2.5.0; extra == 's3'
+Provides-Extra: tinymce
+Requires-Dist: nh3>=0.2.14; extra == 'tinymce'
+Description-Content-Type: text/markdown
+
+# obox-builder
+
+*An extensible administrative interface framework for FastAPI and Starlette applications.*
+
+> **obox-builder** is a fork of [starlette-admin](https://github.com/jowilf/starlette-admin), originally created by
+> [Jocelin Hounon](https://github.com/jowilf) and licensed under the MIT License. This fork uses the distribution name
+> `obox-builder` on PyPI and the import package `obox_builder`.
+
+<p align="center">
+<a href="https://github.com/vinhgiga/obox-builder/actions/workflows/test.yml">
+    <img src="https://github.com/vinhgiga/obox-builder/actions/workflows/test.yml/badge.svg" alt="Tests">
+</a>
+<a href="https://codecov.io/gh/vinhgiga/obox-builder">
+    <img src="https://codecov.io/gh/vinhgiga/obox-builder/branch/main/graph/badge.svg" alt="Coverage">
+</a>
+<a href="https://pypi.org/project/obox-builder/">
+    <img src="https://badge.fury.io/py/obox-builder.svg" alt="PyPI version">
+</a>
+<a href="https://pypi.org/project/obox-builder/">
+    <img src="https://img.shields.io/pypi/pyversions/obox-builder?color=2334D058" alt="Python versions">
+</a>
+</p>
+
+![Admin panel](https://raw.githubusercontent.com/vinhgiga/obox-builder/refs/heads/main/docs/shared/assets/images/list-preview.png)
+
+## Installation
+```sh
+# Using uv
+uv add obox-builder
+
+# Using pip
+pip install obox-builder
+```
+
+## Quickstart
+
+Get a fully functional administrative dashboard up and running in minutes. This example demonstrates an integration with FastAPI and SQLAlchemy.
+
+```python
+from contextlib import asynccontextmanager
+from datetime import datetime, timezone
+
+from fastapi import FastAPI
+from sqlalchemy import create_engine
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+from obox_builder.contrib.sqla import Admin, ModelView
+
+engine = create_engine("sqlite:///blog.db", connect_args={"check_same_thread": False})
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class Post(Base):
+    __tablename__ = "posts"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    title: Mapped[str]
+    content: Mapped[str]
+    published: Mapped[bool] = mapped_column(default=False)
+    created_at: Mapped[datetime] = mapped_column(
+        default=lambda: datetime.now(timezone.utc)
+    )
+
+
+class PostView(ModelView):
+    fields = ["id", "title", "content", "published", "created_at"]
+    searchable_fields = ("title", "content")
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    Base.metadata.create_all(engine)
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+admin = Admin(engine, title="Blog Admin", secret_key="change-me")
+admin.add_view(PostView(Post, icon="fa fa-newspaper"))
+admin.mount_to(app)
+```
+
+Run with `fastapi dev` and open [http://127.0.0.1:8000/admin](http://127.0.0.1:8000/admin).
+
+## Features
+
+- Generated CRUD pages for your models
+- Pagination, sorting, search, and shareable URLs
+- Nested AND/OR filter builder
+- Inline editing for related models
+- Bulk actions and custom row actions
+- CSV, Excel, JSON, and PDF export
+- CSV, JSON and Excel import with dry-run validation
+- Local and S3-compatible file storage (Amazon S3, MinIO, ...)
+- Event hooks before and after CRUD operations
+- Pluggable authentication, storage, fields, actions, and model views
+- Theme customization, dark mode, internationalization, and timezone support
+
+
+
+## Supported ORMs & Backends
+
+`obox-builder` is built to be agnostic. It ships with built-in support for popular ORMs and databases:
+
+| Backend | Package Path |
+| --- | --- |
+| **SQLAlchemy** | `obox_builder.contrib.sqla` |
+| **SQLModel** | `obox_builder.contrib.sqlmodel` |
+| **Tortoise ORM** | `obox_builder.contrib.tortoise` |
+| **Beanie (MongoDB)** | `obox_builder.contrib.beanie` |
+| **MongoEngine** | `obox_builder.contrib.mongoengine` |
+| **Custom Data Sources** | Subclass `BaseModelView` |
+
+---
+
+## Documentation & Resources
+
+* **[Full Documentation](https://vinhgiga.github.io/obox-builder)**
+* **[Quickstart Guide](https://vinhgiga.github.io/obox-builder/getting-started/quickstart/)**
+* **[User Guide](https://vinhgiga.github.io/obox-builder/user-guide/views/)** (Covers views, fields, filters, actions, and auth)
+* **[API Reference](https://vinhgiga.github.io/obox-builder/api/admin/)**
+
+## Live Demo
+
+Explore the upstream interface in action: **[starlette-admin-demo.jowilf.com](https://starlette-admin-demo.jowilf.com/)**
+
+## Contributing
+
+Contributions are always welcome! Whether it is reporting a bug, discussing improvements, or submitting a pull request, your input helps make this project better.
+
+Please review our **[CONTRIBUTING.md](https://github.com/vinhgiga/obox-builder/blob/main/CONTRIBUTING.md)** guidelines before opening a pull request.
+
+## License
+
+This project is licensed under the **MIT License**.

obox_builder-1.0.2/README.md

@@ -0,0 +1,136 @@
+# obox-builder
+
+*An extensible administrative interface framework for FastAPI and Starlette applications.*
+
+> **obox-builder** is a fork of [starlette-admin](https://github.com/jowilf/starlette-admin), originally created by
+> [Jocelin Hounon](https://github.com/jowilf) and licensed under the MIT License. This fork uses the distribution name
+> `obox-builder` on PyPI and the import package `obox_builder`.
+
+<p align="center">
+<a href="https://github.com/vinhgiga/obox-builder/actions/workflows/test.yml">
+    <img src="https://github.com/vinhgiga/obox-builder/actions/workflows/test.yml/badge.svg" alt="Tests">
+</a>
+<a href="https://codecov.io/gh/vinhgiga/obox-builder">
+    <img src="https://codecov.io/gh/vinhgiga/obox-builder/branch/main/graph/badge.svg" alt="Coverage">
+</a>
+<a href="https://pypi.org/project/obox-builder/">
+    <img src="https://badge.fury.io/py/obox-builder.svg" alt="PyPI version">
+</a>
+<a href="https://pypi.org/project/obox-builder/">
+    <img src="https://img.shields.io/pypi/pyversions/obox-builder?color=2334D058" alt="Python versions">
+</a>
+</p>
+
+![Admin panel](https://raw.githubusercontent.com/vinhgiga/obox-builder/refs/heads/main/docs/shared/assets/images/list-preview.png)
+
+## Installation
+```sh
+# Using uv
+uv add obox-builder
+
+# Using pip
+pip install obox-builder
+```
+
+## Quickstart
+
+Get a fully functional administrative dashboard up and running in minutes. This example demonstrates an integration with FastAPI and SQLAlchemy.
+
+```python
+from contextlib import asynccontextmanager
+from datetime import datetime, timezone
+
+from fastapi import FastAPI
+from sqlalchemy import create_engine
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+from obox_builder.contrib.sqla import Admin, ModelView
+
+engine = create_engine("sqlite:///blog.db", connect_args={"check_same_thread": False})
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class Post(Base):
+    __tablename__ = "posts"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    title: Mapped[str]
+    content: Mapped[str]
+    published: Mapped[bool] = mapped_column(default=False)
+    created_at: Mapped[datetime] = mapped_column(
+        default=lambda: datetime.now(timezone.utc)
+    )
+
+
+class PostView(ModelView):
+    fields = ["id", "title", "content", "published", "created_at"]
+    searchable_fields = ("title", "content")
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    Base.metadata.create_all(engine)
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+admin = Admin(engine, title="Blog Admin", secret_key="change-me")
+admin.add_view(PostView(Post, icon="fa fa-newspaper"))
+admin.mount_to(app)
+```
+
+Run with `fastapi dev` and open [http://127.0.0.1:8000/admin](http://127.0.0.1:8000/admin).
+
+## Features
+
+- Generated CRUD pages for your models
+- Pagination, sorting, search, and shareable URLs
+- Nested AND/OR filter builder
+- Inline editing for related models
+- Bulk actions and custom row actions
+- CSV, Excel, JSON, and PDF export
+- CSV, JSON and Excel import with dry-run validation
+- Local and S3-compatible file storage (Amazon S3, MinIO, ...)
+- Event hooks before and after CRUD operations
+- Pluggable authentication, storage, fields, actions, and model views
+- Theme customization, dark mode, internationalization, and timezone support
+
+
+
+## Supported ORMs & Backends
+
+`obox-builder` is built to be agnostic. It ships with built-in support for popular ORMs and databases:
+
+| Backend | Package Path |
+| --- | --- |
+| **SQLAlchemy** | `obox_builder.contrib.sqla` |
+| **SQLModel** | `obox_builder.contrib.sqlmodel` |
+| **Tortoise ORM** | `obox_builder.contrib.tortoise` |
+| **Beanie (MongoDB)** | `obox_builder.contrib.beanie` |
+| **MongoEngine** | `obox_builder.contrib.mongoengine` |
+| **Custom Data Sources** | Subclass `BaseModelView` |
+
+---
+
+## Documentation & Resources
+
+* **[Full Documentation](https://vinhgiga.github.io/obox-builder)**
+* **[Quickstart Guide](https://vinhgiga.github.io/obox-builder/getting-started/quickstart/)**
+* **[User Guide](https://vinhgiga.github.io/obox-builder/user-guide/views/)** (Covers views, fields, filters, actions, and auth)
+* **[API Reference](https://vinhgiga.github.io/obox-builder/api/admin/)**
+
+## Live Demo
+
+Explore the upstream interface in action: **[starlette-admin-demo.jowilf.com](https://starlette-admin-demo.jowilf.com/)**
+
+## Contributing
+
+Contributions are always welcome! Whether it is reporting a bug, discussing improvements, or submitting a pull request, your input helps make this project better.
+
+Please review our **[CONTRIBUTING.md](https://github.com/vinhgiga/obox-builder/blob/main/CONTRIBUTING.md)** guidelines before opening a pull request.
+
+## License
+
+This project is licensed under the **MIT License**.

obox_builder-1.0.2/obox_builder/__init__.py

@@ -0,0 +1,155 @@
+__version__ = "1.0.2"
+
+from .actions import ActionSelection as ActionSelection
+from .actions import action as action
+from .actions import link_row_action as link_row_action
+from .actions import row_action as row_action
+from .base import BaseAdmin as BaseAdmin
+from .fields import ArrowField as ArrowField
+from .fields import BaseField as BaseField
+from .fields import BooleanField as BooleanField
+from .fields import CollectionField as CollectionField
+from .fields import ColorField as ColorField
+from .fields import ComputedField as ComputedField
+from .fields import CountryField as CountryField
+from .fields import CurrencyField as CurrencyField
+from .fields import DateField as DateField
+from .fields import DateTimeField as DateTimeField
+from .fields import DecimalField as DecimalField
+from .fields import EmailField as EmailField
+from .fields import EnumField as EnumField
+from .fields import FileField as FileField
+from .fields import FloatField as FloatField
+from .fields import HasMany as HasMany
+from .fields import HasOne as HasOne
+from .fields import ImageField as ImageField
+from .fields import IntegerField as IntegerField
+from .fields import IPAddressField as IPAddressField
+from .fields import JSONField as JSONField
+from .fields import ListField as ListField
+from .fields import NumberField as NumberField
+from .fields import PasswordField as PasswordField
+from .fields import PhoneField as PhoneField
+from .fields import RelationField as RelationField
+from .fields import SlugField as SlugField
+from .fields import StringField as StringField
+from .fields import TagsField as TagsField
+from .fields import TextAreaField as TextAreaField
+from .fields import TimeField as TimeField
+from .fields import TimeZoneField as TimeZoneField
+from .fields import TinyMCEEditorField as TinyMCEEditorField
+from .fields import URLField as URLField
+from .fields import UUIDField as UUIDField
+from .flash import flash as flash
+from .flash import get_flashed_messages as get_flashed_messages
+from .i18n import I18nConfig as I18nConfig
+from .i18n import TimezoneConfig as TimezoneConfig
+from .plugins import BasePlugin as BasePlugin
+from .plugins import PluginError as PluginError
+from .routing import route as route
+from .theme import BaseTheme as BaseTheme
+from .theme import DefaultTheme as DefaultTheme
+from .theme import TablerSettings as TablerSettings
+from .types import RequestAction as RequestAction
+from .types import RowActionsDisplayType as RowActionsDisplayType
+from .types import RowActionsPosition as RowActionsPosition
+from .views import BaseModelView as BaseModelView
+from .views import CustomView as CustomView
+from .views import DefaultIndexView as DefaultIndexView
+from .views import DropDown as DropDown
+from .views import InlineModelView as InlineModelView
+from .views import Link as Link
+from .widgets import BaseWidget as BaseWidget
+from .widgets import Breakpoints as Breakpoints
+from .widgets import CardRowWidget as CardRowWidget
+from .widgets import ChartWidget as ChartWidget
+from .widgets import Col as Col
+from .widgets import ColumnWidget as ColumnWidget
+from .widgets import DividerWidget as DividerWidget
+from .widgets import FieldRef as FieldRef
+from .widgets import FieldsetWidget as FieldsetWidget
+from .widgets import GridWidget as GridWidget
+from .widgets import HtmlWidget as HtmlWidget
+from .widgets import PanelWidget as PanelWidget
+from .widgets import RowWidget as RowWidget
+from .widgets import StatWidget as StatWidget
+from .widgets import TableWidget as TableWidget
+from .widgets import TabsWidget as TabsWidget
+from .widgets import TextWidget as TextWidget
+
+__all__ = [
+    "ActionSelection",
+    "ArrowField",
+    "BaseAdmin",
+    "BaseField",
+    "BaseModelView",
+    "BaseTheme",
+    "BaseWidget",
+    "BooleanField",
+    "Breakpoints",
+    "CardRowWidget",
+    "ChartWidget",
+    "Col",
+    "CollectionField",
+    "ColorField",
+    "ColumnWidget",
+    "ComputedField",
+    "CountryField",
+    "CurrencyField",
+    "CustomView",
+    "DateField",
+    "DateTimeField",
+    "DecimalField",
+    "DefaultIndexView",
+    "DefaultTheme",
+    "DividerWidget",
+    "DropDown",
+    "EmailField",
+    "EnumField",
+    "FieldRef",
+    "FieldsetWidget",
+    "FileField",
+    "FloatField",
+    "GridWidget",
+    "HasMany",
+    "HasOne",
+    "HtmlWidget",
+    "I18nConfig",
+    "IPAddressField",
+    "ImageField",
+    "InlineModelView",
+    "IntegerField",
+    "JSONField",
+    "Link",
+    "ListField",
+    "NumberField",
+    "PanelWidget",
+    "PasswordField",
+    "PhoneField",
+    "RelationField",
+    "RequestAction",
+    "RowActionsDisplayType",
+    "RowActionsPosition",
+    "RowWidget",
+    "SlugField",
+    "StatWidget",
+    "StringField",
+    "TableWidget",
+    "TablerSettings",
+    "TabsWidget",
+    "TagsField",
+    "TextAreaField",
+    "TextWidget",
+    "TimeField",
+    "TimeZoneField",
+    "TimezoneConfig",
+    "TinyMCEEditorField",
+    "URLField",
+    "UUIDField",
+    "action",
+    "flash",
+    "get_flashed_messages",
+    "link_row_action",
+    "route",
+    "row_action",
+]