跳转到主要内容

为Flask提供简单易用且可扩展的行政界面框架

项目描述

该项目最近被迁移到其自己的组织。请更新您的引用为 git@github.com:flask-admin/flask-admin.git

https://d322cqt584bo4o.cloudfront.net/flask-admin/localized.svg https://github.com/flask-admin/flask-admin/actions/workflows/test.yaml/badge.svg

简介

Flask-Admin 是一个功能齐全、简单易用的 Flask 扩展,允许您向 Flask 应用程序添加管理界面。它受 django-admin 包的启发,但以这种方式实现,开发人员可以完全控制最终应用程序的外观、感觉和功能。

开箱即用,Flask-Admin 与各种 ORM(对象关系映射)兼容,包括

它还提供简单的文件管理界面和 redis 客户端 控制台。

Flask-Admin 的最大特点是灵活性。它旨在提供一套简单的工具,可用于构建任何复杂性的管理界面。因此,您可以从创建一个简单应用程序开始,无需时间即可为您的每个模型生成自动化的 CRUD 视图。但随着需要,您还可以进一步自定义这些视图和表单。

Flask-Admin 是一个活跃的项目,经过良好测试且适用于生产环境。

示例

/examples文件夹中包含了几个使用示例。请添加您自己的示例,或者改进现有示例,并提交一个pull-request

在本地环境中运行示例

1. Clone the repository::

      git clone https://github.com/flask-admin/flask-admin.git
      cd flask-admin

2. Create and activate a virtual environment::

      virtualenv env -p python3
      source env/bin/activate

3. Install requirements::

      pip install -r examples/sqla/requirements.txt

4. Run the application::

      python examples/sqla/run_server.py

文档

Flask-Admin有详尽的文档,您可以在https://flask-admin.readthedocs.io/en/latest/找到所有文档。

文档是从/doc文件夹中的.rst文件自动生成的。所以如果您发现任何错误,或者有其他应该包含的内容,请进行修改并提交pull-request

在本地环境中构建文档,从项目目录

tox -e docs-html

如果您想要预览可能想要贡献的任何.rst片段,请访问http://rst.ninjs.org/

安装

要安装Flask-Admin,只需

pip install flask-admin

或者,您也可以下载仓库并手动安装,执行

git clone git@github.com:flask-admin/flask-admin.git
cd flask-admin
python setup.py install

测试

测试使用pytest运行。如果您不熟悉这个包,可以从他们的网站获取更多信息。

要运行测试,从项目目录,只需

pip install -r requirements-dev.txt
pytest

您应该看到类似以下输出

.............................................
----------------------------------------------------------------------
Ran 102 tests in 13.132s

OK

要成功通过所有测试,您需要在本地运行Postgres & MongoDB。对于Postgres

> psql postgres
CREATE DATABASE flask_admin_test;
\q

> psql flask_admin_test
CREATE EXTENSION postgis;
CREATE EXTENSION hstore;

如果您在MacOS上使用Homebrew,可能需要这个

# install postgis
> brew install postgis

# set up postgresql user
> createuser -s postgresql
> brew services restart postgresql

您也可以使用tox在多个环境中运行测试。

第三方库

Flask-Admin是在BootstrapSelect2Bootswatch的帮助下构建的。

如果您想本地化应用程序,请安装Flask-BabelEx包。

您可以通过Crowdin帮助改进Flask-Admin的翻译:https://crowdin.com/project/flask-admin

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解安装包的更多信息。

源代码分发

Flask-Admin-1.6.1.tar.gz (6.7 MB 查看散列)

源代码

构建分发

Flask_Admin-1.6.1-py3-none-any.whl (7.5 MB 查看散列)

上传于 Python 3

由以下支持