Skip to content

Commit 4c8a3de

Browse files
committed
Fixed #14
1 parent 13cc469 commit 4c8a3de

3 files changed

Lines changed: 51 additions & 22 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,19 @@ FastAdmin is designed to be minimalistic, functional and yet familiar.
3434
#### Install the package using pip:
3535

3636
```bash
37-
pip install fastadmin
37+
pip install fastadmin["fastapi"] # for fastapi
38+
pip install fastadmin["flask"] # for flask
39+
pip install fastadmin["django"] # for django
40+
pip install fastadmin["fastapi,django,flask"] # for multiple
41+
```
42+
43+
or using poetry
44+
45+
```bash
46+
poetry add 'fastadmin["fastapi"]' # for fastapi
47+
poetry add 'fastadmin["flask"]' # for flask
48+
poetry add 'fastadmin["django"]' # for django
49+
poetry add 'fastadmin["fastapi,django,flask"]' # for multiple
3850
```
3951

4052
#### Setup ENV variables
@@ -101,7 +113,6 @@ flask ...
101113

102114
Go to [http://localhost:5000/admin](http://localhost:5000/admin).
103115

104-
105116
#### For Django:
106117

107118
In root urls.py
@@ -125,7 +136,6 @@ python manage.py runserver
125136

126137
Go to [http://localhost:8000/admin](http://localhost:8000/admin).
127138

128-
129139
### Register ORM models:
130140

131141
You have to implement authenticate method for FastAdmin authentication on AdminModel class which is registered for ADMIN_USER_MODEL.

docs/index.html

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
name="viewport"
88
content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no"
99
/>
10-
<meta name="google-site-verification" content="c45rQ5FmAgrb6scHcK2hORmVz_8MwX6HRXrKpYu3vMw" />
10+
<meta
11+
name="google-site-verification"
12+
content="c45rQ5FmAgrb6scHcK2hORmVz_8MwX6HRXrKpYu3vMw"
13+
/>
1114
<link href="assets/images/favicon.png" rel="icon" />
1215
<title>FastAdmin | Documentation</title>
1316
<meta
@@ -253,7 +256,19 @@ <h3>Installation</h3>
253256
<p class="lead">Install the package using pip:</p>
254257
<pre>
255258
<code class="language-bash">
256-
pip install fastadmin
259+
pip install fastadmin["fastapi"] # for fastapi
260+
pip install fastadmin["flask"] # for flask
261+
pip install fastadmin["django"] # for django
262+
pip install fastadmin["fastapi,django,flask"] # for multiple
263+
</code>
264+
</pre>
265+
<p class="lead">Or using poetry:</p>
266+
<pre>
267+
<code class="language-bash">
268+
poetry add 'fastadmin["fastapi"]' # for fastapi
269+
poetry add 'fastadmin["flask"]' # for flask
270+
poetry add 'fastadmin["django"]' # for django
271+
poetry add 'fastadmin["fastapi,django,flask"]' # for multiple
257272
</code>
258273
</pre>
259274
<p class="lead">
@@ -297,8 +312,8 @@ <h4>FastAPI Framework</h4>
297312
...
298313
</code>
299314
</pre>
300-
<h4>Flask Framework</h4>
301-
<pre>
315+
<h4>Flask Framework</h4>
316+
<pre>
302317
<code class="language-python">
303318
from flask import Flask
304319
from fastadmin import flask_app as admin_app
@@ -315,9 +330,7 @@ <h4>Flask Framework</h4>
315330
</code>
316331
</pre>
317332
<h4>Django Framework</h4>
318-
<p class="lead">
319-
In root urls.py:
320-
</p>
333+
<p class="lead">In root urls.py:</p>
321334
<pre>
322335
<code class="language-python">
323336
from django.urls import path
@@ -878,9 +891,7 @@ <h2>InlineModelAdmin objects</h2>
878891
The admin interface has the ability to edit models on the same
879892
page as a parent model. These are called inlines.
880893
</p>
881-
<p class="lead">
882-
Tortoise Example:
883-
</p>
894+
<p class="lead">Tortoise Example:</p>
884895
<pre>
885896
<code class="language-python">
886897
from tortoise.models import Model
@@ -1062,12 +1073,7 @@ <h3 id="#v0_1_18">
10621073
</footer>
10631074
</div>
10641075

1065-
<a
1066-
id="back-to-top"
1067-
data-toggle="tooltip"
1068-
title="Back to Top"
1069-
href="#"
1070-
>
1076+
<a id="back-to-top" data-toggle="tooltip" title="Back to Top" href="#">
10711077
^
10721078
</a>
10731079

fastadmin/__init__.py

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# api
2-
from fastadmin.api.frameworks.django.app.urls import get_admin_urls
3-
from fastadmin.api.frameworks.fastapi.app import app as fastapi_app
4-
from fastadmin.api.frameworks.flask.app import app as flask_app
2+
import logging
3+
4+
try:
5+
from fastadmin.api.frameworks.django.app.urls import get_admin_urls
6+
except ModuleNotFoundError:
7+
logging.info("Django not installed")
8+
9+
try:
10+
from fastadmin.api.frameworks.fastapi.app import app as fastapi_app
11+
except ModuleNotFoundError:
12+
logging.info("FastAPI not installed")
13+
14+
try:
15+
from fastadmin.api.frameworks.flask.app import app as flask_app
16+
except ModuleNotFoundError:
17+
logging.info("Flask not installed")
518

619
# models
720
from fastadmin.models.base import InlineModelAdmin, ModelAdmin

0 commit comments

Comments
 (0)