Skip to content

Commit

Permalink
major documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
briancappello committed Dec 8, 2021
1 parent 60db83b commit be23381
Show file tree
Hide file tree
Showing 19 changed files with 1,803 additions and 826 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Flask Unchained

## The quickest and easiest way to build large web apps and APIs with Flask and SQLAlchemy
## The quickest and easiest way to build web apps and APIs with Flask

**Flask Unchained is a Flask extension, a pluggable application factory, and a set of mostly optional "bundles" that together create a modern, fully integrated, and highly customizable web framework *for* Flask and its extension ecosystem.** Flask Unchained aims to stay true to the spirit and API of Flask, while making it significantly easier to quickly build large web apps and APIs with Flask and SQLAlchemy.
**Flask Unchained is a Flask extension, a pluggable application factory, and a set of mostly optional "bundles" that together create a modern, fully integrated, and highly customizable web framework *for* Flask and its extension ecosystem.** Flask Unchained aims to stay true to the spirit and API of Flask, while making it significantly easier to quickly build web apps and APIs with Python.

Flask Unchained introduces "bundles" to Flask: bundles are Python packages that integrate functionality with Flask, Flask Unchained, and other bundles. That could mean anything from integrating vanilla Flask extensions to being full-blown apps *your* app can integrate, customize, and extend (like say, a blog or web store). Unlike vanilla Flask extensions, bundles are both consistent and highly extensible and customizable. Once you figure out how something works in one bundle, it's the same in every other bundle. They are conceptually similar to Django's "apps", but I think you'll find bundles are even more powerful and flexible.

Expand Down
10 changes: 7 additions & 3 deletions docs/bundles/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,20 @@ Install dependencies:

.. code:: bash
pip install "flask-unchained[admin]"
pip install "flask-unchained[sqlalchemy,session,security,admin]"
Enable the bundle in your ``unchained_config.py``:
Enable the bundle in your ``BUNDLES``:

.. code:: python
# project-root/unchained_config.py
BUNDLES = [
# ...
'flask_unchained.bundles.babel', # required by Security Bundle
'flask_unchained.bundles.session', # required by Security Bundle
'flask_unchained.bundles.sqlalchemy', # required by Admin Bundle
'flask_unchained.bundles.security', # required by Admin Bundle
'flask_unchained.bundles.admin',
'app',
]
Expand All @@ -31,8 +35,8 @@ And include the Admin Bundle's routes:
# project-root/your_app_bundle/routes.py
routes = lambda: [
include('flask_unchained.bundles.admin.routes'),
# ...
include('flask_unchained.bundles.admin.routes'),
]
Config
Expand Down
2 changes: 1 addition & 1 deletion docs/bundles/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ And that's it, unless you need to customize any behavior.
* - serializer_create
- The serializer instance to use for loading data for creation of a new model.
- Determined automatically by the model name. Can be set manually to override the automatic discovery.
* - serializer_many
* - serializer_list
- The serializer instance to use for (de)serializing a list of models.
- Determined automatically by the model name. Can be set manually to override the automatic discovery.
* - include_methods
Expand Down
4 changes: 2 additions & 2 deletions docs/bundles/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
.. BEGIN document -------------------------------------------------------------
Included Bundles
================
Bundles
=======

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
'globaltoc_includehidden': False,

'heroes': {
'*': 'The quickest and easiest way to build large web apps and APIs with Flask and SQLAlchemy',
'*': 'The quickest and easiest way to build web apps and APIs with Flask',
},
# disable tabs below the hero
'master_doc': False,
Expand Down
Loading

0 comments on commit be23381

Please sign in to comment.