Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgaspar committed Feb 3, 2015
1 parent c448c20 commit 82bd3b2
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 22 deletions.
1 change: 1 addition & 0 deletions README.rst
Expand Up @@ -47,6 +47,7 @@ Includes:

- Database
- SQLAlchemy, multiple database support: sqlite, MySQL, ORACLE, MSSQL, DB2 etc.
- Partial support for MongoDB using MongoEngine.
- Multiple database connections support (Vertical partitioning).
- Easy mixin audit to models (created/changed by user, and timestamps).
- Security
Expand Down
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.txt
Expand Up @@ -27,6 +27,7 @@ Contents:

intro
installation
fabmanager
config

.. toctree::
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/index.html
Expand Up @@ -75,6 +75,7 @@ <h2>Contents:<a class="headerlink" href="#contents" title="Permalink to this hea
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="fabmanager.html">Command Line Manager</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Base Configuration</a></li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

53 changes: 32 additions & 21 deletions docs/fabmanager.rst
Expand Up @@ -2,24 +2,35 @@ Command Line Manager
====================

Since version 1.3.0 F.A.B. has a command line manager, you can use it for many development tasks.
Many of the commands are design to import AppBuilder class initialized by your application.
Many of the commands are design to import **AppBuilder** class initialized by your application.
By default it will assume your application follows the skeleton structure, so it will try to import
appbuilder from app/__init__.py. You can pass your own info to where is appbuilder being initialized.
appbuilder from *app/__init__.py*. You can pass your own info to where appbuilder is being initialized.

Take a quick look to the current possibilities. The bold ones require your appbuilder.

babel-compile - Babel, Compiles all translations
babel-extract - Babel, Extracts and updates all messages.
**create-admin** - Creates an admin user
create-app - Create a Skeleton application (SQLAlchemy or MongoEngine).
**create-db** - Create all your database objects (SQLAlchemy only)
**list-users** - List all users on the database.
**list-views** - List all registered views.
**reset-password** - Resets a user's password.
**run** - Runs Flask dev web server.
**security-cleanup** - Cleanup unused permissions from views and roles.
**upgrade-db** - Upgrade your database after F.A.B upgrade.
**version** - Flask-AppBuilder package version.
- babel-compile - Babel, Compiles all translations

- babel-extract - Babel, Extracts and updates all messages.

- **create-admin** - Creates an admin user

- create-app - Create a Skeleton application (SQLAlchemy or MongoEngine).

- **create-db** - Create all your database objects (SQLAlchemy only)

- **list-users** - List all users on the database.

- **list-views** - List all registered views.

- **reset-password** - Resets a user's password.

- **run** - Runs Flask dev web server.

- **security-cleanup** - Cleanup unused permissions from views and roles.

- **upgrade-db** - Upgrade your database after F.A.B upgrade.

- **version** - Flask-AppBuilder package version.

Command Line uses the excelent click package, so you can have a detailed help for each command, for instance::

Expand All @@ -36,17 +47,17 @@ Command Line uses the excelent click package, so you can have a detailed help fo
--help Show this message and exit.


**create-app** Create new Applications
--------------------------------------
**create-app** - Create new Applications
----------------------------------------

To create a ready to dev skeleton application, you can use this command for SQLAlchemy engine and MongoEngine (MongoDB).
This commands needs an internet connection to **github.com**, because it will download a zip version of the skeleton repos.

**create-admin** Create an admin user
-------------------------------------
**create-admin** - Create an admin user
---------------------------------------

Use this to create your first **Admin** user, or additional ones. issue on the root directory of your application
if your initializing **AppBuilder** on app/__init__.py and have named it appbuilder. If not use the **--app** and
if your initializing **AppBuilder** on *app/__init__.py* and have named it appbuilder. If not use the **--app** and
**--appbuilder** switches to identify how to import **appbuilder**.

This admin user can be used to any type of authentication method configured, but *fabmanager* will not checkit so
Expand All @@ -62,8 +73,8 @@ Issue on the root directory of your application
if your initializing **AppBuilder** on app/__init__.py and have named it appbuilder. If not use the **--app** and
**--appbuilder** switches to identify how to import **appbuilder**.

**reset-password** Resets a user's password.
--------------------------------------------
**reset-password** - Resets a user's password.
----------------------------------------------

Reset a user's password, also needs to import **appbuilder** so
Issue on the root directory of your application
Expand Down

0 comments on commit 82bd3b2

Please sign in to comment.