{ "info": { "author": "Artem Shelest", "author_email": "artem.e.shelest@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Flask-Admin-Subview\n===================\n\nEmbed Flask-Admin list views to an arbitrary page:\n\n.. image:: https://raw.githubusercontent.com/artemShelest/flask-admin-subview/master/res/screen1.png\n\n.. image:: https://raw.githubusercontent.com/artemShelest/flask-admin-subview/master/res/screen2.png\n\nLimitations\n===========\n\n- Inline edits are not supported\n- Bootstrap3 templates only\n\nInstallation\n============\n\n.. code-block:: console\n\n pip install flask-admin-subview\n\n\nIntegration\n===========\n\nThe easiest way to integrate is to use helpers for the details view of the model. The following example demonstrates\nintegration of subview to show relations of SQLAlchemy model in the details page.\n\n**DB Schema**\n\n.. code-block:: python\n\n class ContentModel(db.Model):\n __table__ = \"content\"\n id = db.Column(db.Integer, primary_key=True)\n container_id = db.Column(db.Integer, db.ForeignKey(\"container.id\"), nullable=False)\n\n class ContainerModel(db.Model):\n __table__ = \"container\"\n id = db.Column(db.Integer, primary_key=True)\n content = db.relationship(ContentModel)\n\n\n**Prepare your subview**\n\nIt is a good idea to subclass existing view of your model:\n\n.. code-block:: python\n\n import flask_admin_subview\n\n class ContentModelSubview(flask_admin_subview.View, ContentModelView):\n pass\n\n\nOr you can create a brand-new view for the subview:\n\n.. code-block:: python\n\n from flask_admin.contrib.sqla import ModelView\n import flask_admin_subview\n\n class ContentModelSubview(flask_admin_subview.View, ModelView):\n pass\n\n\nAdd query filter to show content for certain container only, container id will be passed as a URL parameter:\n\n.. code-block:: python\n\n class ContentModelSubview(...):\n def get_query(self):\n return self._extend_query(super(ContentModelSubview, self).get_query())\n\n def get_count_query(self):\n return self._extend_query(super(ContentModelSubview, self).get_count_query())\n\n def _extend_query(self, query):\n container_id = request.args.get('id')\n if container_id is None:\n abort(400, \"Container id required\")\n return query.filter(ContentModel.container_id == container_id)\n\n\n**Initialize an extension**\n\n.. code-block:: python\n\n from flask_admin_subview import Subview\n\n app = Flask(__name__)\n admin = Admin(app, template_mode=\"bootstrap3\")\n # only supports bootstrap3 mode\n Subview(app, template_mode=\"bootstrap3\")\n\n\n**Add your subview as a blueprint**\n\n.. code-block:: python\n\n app = Flask(__name__)\n # ...\n app.register_blueprint(\n ContentModelSubview(Content, db.session, \"Content\", endpoint=\"content_subview\").\n create_blueprint(admin))\n\n\n**Prepare container view**\n\nUse helper to display subview in the model's details:\n\n.. code-block:: python\n\n from flask_admin_subview import SubviewContainerMixin, SubviewEntry\n\n class ContainerView(SubviewContainerMixin, ModelView):\n can_view_details = True\n subviews = (\n # specify that we need to pass id from the location URL to the subview\n SubviewEntry(\"/admin/content_subview/\", \"Content Subview\", \"id\"),\n )\n\n\nTODO\n====\n\n- Add tests\n- Add example app code comments\n- Add Bootstrap2 templates\n- Possibly, support inline edits\n- Describe advanced usage", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/artemShelest/flask-admin-subview", "keywords": "flask-admin,list,view,embedded,nested,subview,one-to-many,relation,view relations", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "Flask-Admin-Subview", "package_url": "https://pypi.org/project/Flask-Admin-Subview/", "platform": "any", "project_url": "https://pypi.org/project/Flask-Admin-Subview/", "project_urls": { "Homepage": "https://github.com/artemShelest/flask-admin-subview" }, "release_url": "https://pypi.org/project/Flask-Admin-Subview/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Embedded Flask-Admin list views.", "version": "0.1.1" }, "last_serial": 4681452, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "425be994c5a7c48194ac08ad69003091", "sha256": "6fb9d0a100f60da9003e132ca602b110568fd9ac3a88e34102f7c9ec147b0776" }, "downloads": -1, "filename": "Flask-Admin-Subview-0.1.1.tar.gz", "has_sig": false, "md5_digest": "425be994c5a7c48194ac08ad69003091", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10356, "upload_time": "2019-01-10T14:51:45", "url": "https://files.pythonhosted.org/packages/bb/a7/02be221d9f441c00f727b4937abc2192081f978f91fb73023102da724dd0/Flask-Admin-Subview-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "425be994c5a7c48194ac08ad69003091", "sha256": "6fb9d0a100f60da9003e132ca602b110568fd9ac3a88e34102f7c9ec147b0776" }, "downloads": -1, "filename": "Flask-Admin-Subview-0.1.1.tar.gz", "has_sig": false, "md5_digest": "425be994c5a7c48194ac08ad69003091", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10356, "upload_time": "2019-01-10T14:51:45", "url": "https://files.pythonhosted.org/packages/bb/a7/02be221d9f441c00f727b4937abc2192081f978f91fb73023102da724dd0/Flask-Admin-Subview-0.1.1.tar.gz" } ] }