Flask-Admin
===========
The project was recently moved into its own organization. Please update your
references to *git@github.com:flask-admin/flask-admin.git*.
.. image:: https://d322cqt584bo4o.cloudfront.net/flask-admin/localized.svg
:target: https://crowdin.com/project/flask-admin
.. image:: https://github.com/flask-admin/flask-admin/actions/workflows/test.yaml/badge.svg
:target: https://github.com/flask-admin/flask-admin/actions/workflows/test.yaml
Introduction
------------
Flask-Admin is a batteries-included, simple-to-use `Flask <http://flask.pocoo.org/>`_ extension that lets you
add admin interfaces to Flask applications. It is inspired by the *django-admin* package, but implemented in such
a way that the developer has total control of the look, feel and functionality of the resulting application.
Out-of-the-box, Flask-Admin plays nicely with various ORM's, including
- `SQLAlchemy <http://www.sqlalchemy.org/>`_,
- `MongoEngine <http://mongoengine.org/>`_,
- `pymongo <http://api.mongodb.org/python/current/>`_ and
- `Peewee <https://github.com/coleifer/peewee>`_.
It also boasts a simple file management interface and a `redis client <http://redis.io/>`_ console.
The biggest feature of Flask-Admin is flexibility. It aims to provide a set of simple tools that can be used for
building admin interfaces of any complexity. So, to start off with you can create a very simple application in no time,
with auto-generated CRUD-views for each of your models. But then you can go further and customize those views & forms
as the need arises.
Flask-Admin is an active project, well-tested and production ready.
Examples
--------
Several usage examples are included in the */examples* folder. Please add your own, or improve
on the existing examples, and submit a *pull-request*.
To run the examples in your local environment::
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
Documentation
-------------
Flask-Admin is extensively documented, you can find all of the documentation at `https://flask-admin.readthedocs.io/en/latest/ <https://flask-admin.readthedocs.io/en/latest/>`_.
The docs are auto-generated from the *.rst* files in the */doc* folder. So if you come across any errors, or
if you think of anything else that should be included, then please make the changes and submit them as a *pull-request*.
To build the docs in your local environment, from the project directory::
tox -e docs-html
And if you want to preview any *.rst* snippets that you may want to contribute, go to `http://rst.ninjs.org/ <http://rst.ninjs.org/>`_.
Installation
------------
To install Flask-Admin, simply::
pip install flask-admin
Or alternatively, you can download the repository and install manually by doing::
git clone git@github.com:flask-admin/flask-admin.git
cd flask-admin
python setup.py install
Tests
-----
Test are run with *pytest*. If you are not familiar with this package you can get some more info from `their website <https://pytest.org/>`_.
To run the tests, from the project directory, simply::
pip install -r requirements-dev.txt
pytest
You should see output similar to::
.............................................
----------------------------------------------------------------------
Ran 102 tests in 13.132s
OK
For all the tests to pass successfully, you'll need Postgres & MongoDB to be running locally. For Postgres::
> psql postgres
CREATE DATABASE flask_admin_test;
\q
> psql flask_admin_test
CREATE EXTENSION postgis;
CREATE EXTENSION hstore;
If you're using Homebrew on MacOS, you might need this::
# install postgis
> brew install postgis
# set up postgresql user
> createuser -s postgresql
> brew services restart postgresql
You can also run the tests on multiple environments using *tox*.
3rd Party Stuff
---------------
Flask-Admin is built with the help of `Bootstrap <http://getbootstrap.com/>`_, `Select2 <https://github.com/ivaynberg/select2>`_
and `Bootswatch <http://bootswatch.com/>`_.
If you want to localize your application, install the `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>`_ package.
You can help improve Flask-Admin's translations through Crowdin: https://crowdin.com/project/flask-admin
Raw data
{
"_id": null,
"home_page": "https://github.com/flask-admin/flask-admin/",
"name": "Flask-Admin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Flask-Admin team",
"author_email": "serge.koval+github@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/4d/7cad383a93e3e1dd9378f1fcf05ddc532c6d921fb30c19ce8f8583630f24/Flask-Admin-1.6.1.tar.gz",
"platform": "any",
"description": "Flask-Admin\n===========\n\nThe project was recently moved into its own organization. Please update your\nreferences to *git@github.com:flask-admin/flask-admin.git*.\n\n.. image:: https://d322cqt584bo4o.cloudfront.net/flask-admin/localized.svg\n\t:target: https://crowdin.com/project/flask-admin\n\n.. image:: https://github.com/flask-admin/flask-admin/actions/workflows/test.yaml/badge.svg\n\t:target: https://github.com/flask-admin/flask-admin/actions/workflows/test.yaml\n\n\nIntroduction\n------------\n\nFlask-Admin is a batteries-included, simple-to-use `Flask <http://flask.pocoo.org/>`_ extension that lets you\nadd admin interfaces to Flask applications. It is inspired by the *django-admin* package, but implemented in such\na way that the developer has total control of the look, feel and functionality of the resulting application.\n\nOut-of-the-box, Flask-Admin plays nicely with various ORM's, including\n\n- `SQLAlchemy <http://www.sqlalchemy.org/>`_,\n\n- `MongoEngine <http://mongoengine.org/>`_,\n\n- `pymongo <http://api.mongodb.org/python/current/>`_ and\n\n- `Peewee <https://github.com/coleifer/peewee>`_.\n\nIt also boasts a simple file management interface and a `redis client <http://redis.io/>`_ console.\n\nThe biggest feature of Flask-Admin is flexibility. It aims to provide a set of simple tools that can be used for\nbuilding admin interfaces of any complexity. So, to start off with you can create a very simple application in no time,\nwith auto-generated CRUD-views for each of your models. But then you can go further and customize those views & forms\nas the need arises.\n\nFlask-Admin is an active project, well-tested and production ready.\n\nExamples\n--------\nSeveral usage examples are included in the */examples* folder. Please add your own, or improve\non the existing examples, and submit a *pull-request*.\n\nTo run the examples in your local environment::\n\n 1. Clone the repository::\n\n git clone https://github.com/flask-admin/flask-admin.git\n cd flask-admin\n\n 2. Create and activate a virtual environment::\n\n virtualenv env -p python3\n source env/bin/activate\n\n 3. Install requirements::\n\n pip install -r examples/sqla/requirements.txt\n\n 4. Run the application::\n\n python examples/sqla/run_server.py\n\nDocumentation\n-------------\nFlask-Admin is extensively documented, you can find all of the documentation at `https://flask-admin.readthedocs.io/en/latest/ <https://flask-admin.readthedocs.io/en/latest/>`_.\n\nThe docs are auto-generated from the *.rst* files in the */doc* folder. So if you come across any errors, or\nif you think of anything else that should be included, then please make the changes and submit them as a *pull-request*.\n\nTo build the docs in your local environment, from the project directory::\n\n tox -e docs-html\n\nAnd if you want to preview any *.rst* snippets that you may want to contribute, go to `http://rst.ninjs.org/ <http://rst.ninjs.org/>`_.\n\nInstallation\n------------\nTo install Flask-Admin, simply::\n\n pip install flask-admin\n\nOr alternatively, you can download the repository and install manually by doing::\n\n git clone git@github.com:flask-admin/flask-admin.git\n cd flask-admin\n python setup.py install\n\nTests\n-----\nTest are run with *pytest*. If you are not familiar with this package you can get some more info from `their website <https://pytest.org/>`_.\n\nTo run the tests, from the project directory, simply::\n\n pip install -r requirements-dev.txt\n pytest\n\nYou should see output similar to::\n\n .............................................\n ----------------------------------------------------------------------\n Ran 102 tests in 13.132s\n\n OK\n\nFor all the tests to pass successfully, you'll need Postgres & MongoDB to be running locally. For Postgres::\n\n > psql postgres\n CREATE DATABASE flask_admin_test;\n \\q\n\n > psql flask_admin_test\n CREATE EXTENSION postgis;\n CREATE EXTENSION hstore;\n\nIf you're using Homebrew on MacOS, you might need this::\n\n # install postgis\n > brew install postgis\n\n # set up postgresql user\n > createuser -s postgresql\n > brew services restart postgresql\n\nYou can also run the tests on multiple environments using *tox*.\n\n3rd Party Stuff\n---------------\n\nFlask-Admin is built with the help of `Bootstrap <http://getbootstrap.com/>`_, `Select2 <https://github.com/ivaynberg/select2>`_\nand `Bootswatch <http://bootswatch.com/>`_.\n\nIf you want to localize your application, install the `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>`_ package.\n\nYou can help improve Flask-Admin's translations through Crowdin: https://crowdin.com/project/flask-admin\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Simple and extensible admin interface framework for Flask",
"version": "1.6.1",
"project_urls": {
"Homepage": "https://github.com/flask-admin/flask-admin/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61b3656c78dfef163517dbbc9fd106f0604e37b436ad51f9d9450b60e9407e35",
"md5": "8fa8c83bac89449f07a22db23d547d29",
"sha256": "fd8190f1ec3355913a22739c46ed3623f1d82b8112cde324c60a6fc9b21c9406"
},
"downloads": -1,
"filename": "Flask_Admin-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fa8c83bac89449f07a22db23d547d29",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7498141,
"upload_time": "2023-02-20T12:55:32",
"upload_time_iso_8601": "2023-02-20T12:55:32.767492Z",
"url": "https://files.pythonhosted.org/packages/61/b3/656c78dfef163517dbbc9fd106f0604e37b436ad51f9d9450b60e9407e35/Flask_Admin-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be4d7cad383a93e3e1dd9378f1fcf05ddc532c6d921fb30c19ce8f8583630f24",
"md5": "7d7495c280d76bde072d5dc0a69fefc8",
"sha256": "24cae2af832b6a611a01d7dc35f42d266c1d6c75a426b869d8cb241b78233369"
},
"downloads": -1,
"filename": "Flask-Admin-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "7d7495c280d76bde072d5dc0a69fefc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6651224,
"upload_time": "2023-02-20T12:55:41",
"upload_time_iso_8601": "2023-02-20T12:55:41.277129Z",
"url": "https://files.pythonhosted.org/packages/be/4d/7cad383a93e3e1dd9378f1fcf05ddc532c6d921fb30c19ce8f8583630f24/Flask-Admin-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-20 12:55:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flask-admin",
"github_project": "flask-admin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flask-admin"
}
JSON
