Skip to content

F
flask-admin
Commit 5fe6bd03 authored by Serge S. Koval's avatar Serge S. Koval
Browse files
Options

Updated documentation.

parent 820671e1
Hide whitespace changes
Inline Side-by-side
Showing with 68 additions and 269 deletions
TODO.txt
View file @ 5fe6bd03
- Core
- View Site button?
- Localization
- Verify that babel string collection works
- Add localized sample
- Create documentation
- Model Admin
- Reduce number of parameters passed to list view
- Checkboxes and mass operations
- Filters
- Add 'x' to remove filter and remove button
- Custom filters for date fields?
- Change boolean filter to True/False instead of Yes/No
- Ability to sort by fields that are not visible?
......@@ -23,3 +23,4 @@
- Form generation tests
- Documentation
- Add all new stuff
- Change to use :members:
doc/mod_base.rst
View file @ 5fe6bd03
......@@ -9,30 +9,16 @@
.. autofunction:: expose
.. autoclass:: BaseView
.. automethod:: BaseView.__init__
.. automethod:: BaseView.is_accessible
.. automethod:: BaseView.render
Internal
--------
.. automethod:: BaseView.create_blueprint
:members:
Default view
------------
.. autoclass:: AdminIndexView
.. automethod:: __init__
:members:
Admin
-----
.. autoclass:: Admin
.. automethod:: __init__
.. automethod:: add_view
.. automethod:: init_app
.. automethod:: menu
:members:
\ No newline at end of file
doc/mod_ext_fileadmin.rst
View file @ 5fe6bd03
......@@ -4,57 +4,18 @@
.. automodule:: flask.ext.adminex.ext.fileadmin
.. autoclass:: FileAdmin
Permissions
-----------
.. autoattribute:: FileAdmin.can_upload
.. autoattribute:: FileAdmin.can_delete
.. autoattribute:: FileAdmin.can_delete_dirs
.. autoattribute:: FileAdmin.can_mkdir
.. autoattribute:: FileAdmin.can_rename
.. autoattribute:: FileAdmin.allowed_extensions
Templates
---------
.. autoattribute:: FileAdmin.list_template
.. autoattribute:: FileAdmin.upload_template
.. autoattribute:: FileAdmin.mkdir_template
.. autoattribute:: FileAdmin.rename_template
Constructor
-----------
.. automethod:: FileAdmin.__init__
Permissions
-----------
.. automethod:: FileAdmin.is_accessible_path
.. automethod:: FileAdmin.is_file_allowed
Helpers
-------
.. automethod:: FileAdmin.get_base_path
.. automethod:: FileAdmin.get_base_url
.. automethod:: FileAdmin.is_in_folder
.. automethod:: FileAdmin.save_file
Views
-----
.. automethod:: FileAdmin.index
.. automethod:: FileAdmin.upload
.. automethod:: FileAdmin.mkdir
.. automethod:: FileAdmin.delete
.. automethod:: FileAdmin.rename
Internal API
------------
.. automethod:: FileAdmin._get_dir_url
.. automethod:: FileAdmin._get_file_url
.. automethod:: FileAdmin._normalize_path
:members:
:exclude-members: can_upload, can_delete, can_delete_dirs, can_mkdir, can_rename,
allowed_extensions, list_template, upload_template, mkdir_template,
rename_template
.. autoattribute:: can_upload
.. autoattribute:: can_delete
.. autoattribute:: can_delete_dirs
.. autoattribute:: can_mkdir
.. autoattribute:: can_rename
.. autoattribute:: allowed_extensions
.. autoattribute:: list_template
.. autoattribute:: upload_template
.. autoattribute:: mkdir_template
.. autoattribute:: rename_template
doc/mod_ext_sqlamodel.rst
View file @ 5fe6bd03
......@@ -4,104 +4,15 @@
.. automodule:: flask.ext.adminex.ext.sqlamodel
.. autoclass:: ModelView
Permissions
-----------
.. autoattribute:: BaseModelView.can_create
.. autoattribute:: BaseModelView.can_edit
.. autoattribute:: BaseModelView.can_delete
Templates
---------
.. autoattribute:: BaseModelView.list_template
.. autoattribute:: BaseModelView.edit_template
.. autoattribute:: BaseModelView.create_template
Customizations
--------------
.. autoattribute:: BaseModelView.list_columns
.. autoattribute:: BaseModelView.excluded_list_columns
.. autoattribute:: BaseModelView.rename_columns
.. autoattribute:: BaseModelView.sortable_columns
.. autoattribute:: ModelView.searchable_columns
.. autoattribute:: ModelView.column_filters
.. autoattribute:: BaseModelView.form_columns
.. autoattribute:: BaseModelView.excluded_form_columns
.. autoattribute:: BaseModelView.form_args
.. autoattribute:: BaseModelView.page_size
SQLAlchemy-related Customizations
---------------------------------
.. autoattribute:: ModelView.hide_backrefs
.. autoattribute:: ModelView.auto_select_related
.. autoattribute:: ModelView.list_select_related
Constructor
-----------
.. automethod:: ModelView.__init__
Scaffolding
-----------
.. automethod:: ModelView.scaffold_list_columns
.. automethod:: ModelView.scaffold_sortable_columns
.. automethod:: ModelView.scaffold_form
.. automethod:: ModelView.init_search
.. automethod:: ModelView.scaffold_filters
.. autoattribute:: ModelView.filter_converter
Configuration
-------------
.. automethod:: ModelView.get_list_columns
.. automethod:: ModelView.get_sortable_columns
.. automethod:: ModelView.get_create_form
.. automethod:: ModelView.get_edit_form
.. automethod:: ModelView.init_search
Data
----
.. automethod:: ModelView.get_list
.. automethod:: ModelView.get_one
.. automethod:: ModelView.create_model
.. automethod:: ModelView.update_model
.. automethod:: ModelView.delete_model
Helpers
-------
.. automethod:: ModelView.create_form
.. automethod:: ModelView.edit_form
.. automethod:: ModelView.is_sortable
.. automethod:: ModelView.prettify_name
Views
-----
.. automethod:: ModelView.index_view
.. automethod:: ModelView.create_view
.. automethod:: ModelView.edit_view
.. automethod:: ModelView.delete_view
Internal API
------------
.. automethod:: ModelView._get_url
.. automethod:: ModelView.scaffold_auto_joins
.. automethod:: ModelView.is_text_column_type
:members:
:inherited-members:
:exclude-members: hide_backrefs, auto_select_related, list_select_related,
searchable_columns, filter_converter
Class inherits configuration options from :class:`~flask.ext.adminex.model.BaseModelView` and they're not displayed here.
.. autoattribute:: hide_backrefs
.. autoattribute:: auto_select_related
.. autoattribute:: list_select_related
.. autoattribute:: searchable_columns
.. autoattribute:: filter_converter
doc/mod_form.rst
View file @ 5fe6bd03
......@@ -4,5 +4,4 @@
.. automodule:: flask.ext.adminex.form
.. autoclass:: BaseForm
.. autoattribute:: has_file_field
:members:
doc/mod_model.rst
View file @ 5fe6bd03
......@@ -4,95 +4,34 @@
.. automodule:: flask.ext.adminex.model
.. autoclass:: BaseModelView
:members:
:exclude-members: can_create, can_edit, can_delete, list_template, edit_template,
create_template, list_columns, excluded_list_columns, rename_columns,
sortable_columns, searchable_columns, column_filters, form, form_columns,
excluded_form_columns, form_args, form_overrides, page_size
Permissions
-----------
.. autoattribute:: can_create
.. autoattribute:: can_edit
.. autoattribute:: can_delete
.. autoattribute:: BaseModelView.can_create
.. autoattribute:: BaseModelView.can_edit
.. autoattribute:: BaseModelView.can_delete
.. autoattribute:: list_template
.. autoattribute:: edit_template
.. autoattribute:: create_template
Templates
---------
.. autoattribute:: list_columns
.. autoattribute:: excluded_list_columns
.. autoattribute:: rename_columns
.. autoattribute:: BaseModelView.list_template
.. autoattribute:: BaseModelView.edit_template
.. autoattribute:: BaseModelView.create_template
.. autoattribute:: sortable_columns
Customizations
--------------
.. autoattribute:: searchable_columns
.. autoattribute:: BaseModelView.list_columns
.. autoattribute:: BaseModelView.excluded_list_columns
.. autoattribute:: BaseModelView.rename_columns
.. autoattribute:: column_filters
.. autoattribute:: BaseModelView.sortable_columns
.. autoattribute:: form
.. autoattribute:: form_columns
.. autoattribute:: excluded_form_columns
.. autoattribute:: form_args
.. autoattribute:: form_overrides
.. autoattribute:: BaseModelView.searchable_columns
.. autoattribute:: BaseModelView.column_filters
.. autoattribute:: BaseModelView.form_columns
.. autoattribute:: BaseModelView.excluded_form_columns
.. autoattribute:: BaseModelView.form_args
.. autoattribute:: BaseModelView.page_size
Constructor
-----------
.. automethod:: BaseModelView.__init__
Scaffolding
-----------
.. automethod:: BaseModelView.scaffold_pk
.. automethod:: BaseModelView.scaffold_list_columns
.. automethod:: BaseModelView.scaffold_sortable_columns
.. automethod:: BaseModelView.scaffold_form
.. automethod:: BaseModelView.scaffold_filters
Configuration
-------------
.. automethod:: BaseModelView.get_list_columns
.. automethod:: BaseModelView.get_sortable_columns
.. automethod:: BaseModelView.get_create_form
.. automethod:: BaseModelView.get_edit_form
.. automethod:: BaseModelView.init_search
.. automethod:: BaseModelView.get_filters
.. automethod:: BaseModelView.is_valid_filter
Data
----
.. automethod:: BaseModelView.get_list
.. automethod:: BaseModelView.get_one
.. automethod:: BaseModelView.create_model
.. automethod:: BaseModelView.update_model
.. automethod:: BaseModelView.delete_model
Helpers
-------
.. automethod:: BaseModelView.create_form
.. automethod:: BaseModelView.edit_form
.. automethod:: BaseModelView.is_sortable
.. automethod:: BaseModelView.prettify_name
Views
-----
.. automethod:: BaseModelView.index_view
.. automethod:: BaseModelView.create_view
.. automethod:: BaseModelView.edit_view
.. automethod:: BaseModelView.delete_view
Internal API
------------
.. automethod:: BaseModelView._get_url
.. autoattribute:: page_size
flask_adminex/model/base.py
View file @ 5fe6bd03
......@@ -11,16 +11,18 @@ class BaseModelView(BaseView):
Base model view.
View does not make any assumptions on how models are stored or managed, but expects following:
1. Model is an object
2. Model contains properties
3. Each model contains attribute which uniquely identifies it (i.e. primary key for database model)
4. You can get list of sorted models with pagination applied from a data source
5. You can get one model by its identifier from the data source
1. Model is an object
2. Model contains properties
3. Each model contains attribute which uniquely identifies it (i.e. primary key for database model)
4. You can get list of sorted models with pagination applied from a data source
5. You can get one model by its identifier from the data source
Essentially, if you want to support new data store, all you have to do:
1. Derive from `BaseModelView` class
2. Implement various data-related methods (`get_list`, `get_one`, `create_model`, etc)
3. Implement automatic form generation from the model representation (`scaffold_form`)
1. Derive from `BaseModelView` class
2. Implement various data-related methods (`get_list`, `get_one`, `create_model`, etc)
3. Implement automatic form generation from the model representation (`scaffold_form`)
"""
# Permissions
......@@ -114,7 +116,7 @@ class BaseModelView(BaseView):
"""
Collection of the column filters.
Can contain either field names or instances of :class:`flask.ext.adminex.model.filters.BaseFilter` classes.
Can contain either field names or instances of :class:`~flask.ext.adminex.model.filters.BaseFilter` classes.
For example:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment