| Name | Flask-Admix JSON |
| Version |
1.6.1.2
JSON |
| download |
| home_page | |
| Summary | Flask-Admin plus Flask-Admin PRs to extend testing and fix test failures |
| upload_time | 2023-11-07 19:28:38 |
| maintainer | |
| docs_url | None |
| author | Flask-Admin team plus contributors |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Flask-Admix
===========
.. image:: https://github.com/flask-admix/flask-admix/actions/workflows/test.yaml/badge.svg?branch=main
:target: https://github.com/flask-admix/flask-admix/actions/workflows/test.yaml
.. image:: https://img.shields.io/badge/license-BSD--3--Clause-blue
:target: https://opensource.org/license/bsd-3-clause/
This is Flask-Admin plus Flask-Admin PRs to extend testing and fix test failures with newer versions of dependencies,
minus features that are not compatible.
It provides the flask_admin package and therefore cannot be installed in the same environment as Flask-Admin.
- modules that were not tested or had tests that do not pass with newer dependencies have been removed
- fixes only for test failures and some deprecation warnings
- no new features
- no updated documentation
- no updated examples
- no updated translations
The main branch may be rebased at any time. Branches are preserved for each release.
Flask-Admin
===========
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/>`_,
- `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/Scripts/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": "",
"name": "Flask-Admix",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Flask-Admin team plus contributors",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/30/31/e71a2eb0c91a8b70f755257580e4f644d20c1f0d8e4950da70d1457b7974/Flask_Admix-1.6.1.2.tar.gz",
"platform": null,
"description": "Flask-Admix\n===========\n\n.. image:: https://github.com/flask-admix/flask-admix/actions/workflows/test.yaml/badge.svg?branch=main\n\t:target: https://github.com/flask-admix/flask-admix/actions/workflows/test.yaml\n\n.. image:: https://img.shields.io/badge/license-BSD--3--Clause-blue\n\t:target: https://opensource.org/license/bsd-3-clause/\n\nThis is Flask-Admin plus Flask-Admin PRs to extend testing and fix test failures with newer versions of dependencies,\nminus features that are not compatible.\nIt provides the flask_admin package and therefore cannot be installed in the same environment as Flask-Admin.\n\n- modules that were not tested or had tests that do not pass with newer dependencies have been removed\n- fixes only for test failures and some deprecation warnings\n- no new features\n- no updated documentation\n- no updated examples\n- no updated translations\n\nThe main branch may be rebased at any time. Branches are preserved for each release.\n\nFlask-Admin\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- `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/Scripts/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": "",
"summary": "Flask-Admin plus Flask-Admin PRs to extend testing and fix test failures",
"version": "1.6.1.2",
"project_urls": {
"Repository": "https://github.com/flask-admix/flask-admix"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbf099ae9be5d23010e2db01208a8f451cdd18ecbb34dd19cffc32bec397dfe4",
"md5": "a1059de66fecd7219d3fa7d922999742",
"sha256": "adb74ab640d2c8278e742db50ad91809e2bed2d9a55340f5352856fc02122747"
},
"downloads": -1,
"filename": "Flask_Admix-1.6.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1059de66fecd7219d3fa7d922999742",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7390661,
"upload_time": "2023-11-07T19:28:35",
"upload_time_iso_8601": "2023-11-07T19:28:35.878568Z",
"url": "https://files.pythonhosted.org/packages/bb/f0/99ae9be5d23010e2db01208a8f451cdd18ecbb34dd19cffc32bec397dfe4/Flask_Admix-1.6.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3031e71a2eb0c91a8b70f755257580e4f644d20c1f0d8e4950da70d1457b7974",
"md5": "e36466b1179a6823779fbb033a62fba7",
"sha256": "b2ed46859c7ba9aad6d04dbcf7b0f3385cfe494ad810f9f689ef78131d9629ea"
},
"downloads": -1,
"filename": "Flask_Admix-1.6.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e36466b1179a6823779fbb033a62fba7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7434020,
"upload_time": "2023-11-07T19:28:38",
"upload_time_iso_8601": "2023-11-07T19:28:38.175266Z",
"url": "https://files.pythonhosted.org/packages/30/31/e71a2eb0c91a8b70f755257580e4f644d20c1f0d8e4950da70d1457b7974/Flask_Admix-1.6.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-07 19:28:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flask-admix",
"github_project": "flask-admix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flask-admix"
}
