File tree Expand file tree Collapse file tree 1 file changed +17
-8
lines changed
Expand file tree Collapse file tree 1 file changed +17
-8
lines changed Original file line number Diff line number Diff line change @@ -105,25 +105,35 @@ tox -e docs
105105
106106# # Installation
107107
108- To install Flask-Admin, simply:
108+ To install Flask-Admin using pip , simply:
109109
110110` ` ` shell
111111pip install flask-admin
112112` ` `
113113
114- Or alternatively, you can download the repository and install manually
115- by doing:
114+
115+ # # Contributing
116+
117+ If you are a developer working on and maintaining Flask-Admin, checkout the repo by doing:
116118
117119` ` ` shell
118120git clone https://github.com/pallets-eco/flask-admin.git
119121cd flask-admin
120- pip install .
121122` ` `
122123
123- If you are contributing a bug fix or a new feature, you can install the app in editable mode:
124+ Flask-Admin uses [` uv` ](https://docs.astral.sh/uv/) to manage its dependencies and developer environment. With
125+ the repository checked out, to install the minimum version of Python that Flask-Admin supports, create your
126+ virtual environment, and install the required dependencies, run:
127+
128+ ` ` ` shell
129+ uv sync
130+ ` ` `
131+
132+ This will install Flask-Admin but without any of the optional extra dependencies, such as those for sqlalchemy
133+ or mongoengine support. To install all extras, run:
124134
125135` ` ` shell
126- pip install -e " .[ all] "
136+ uv sync --extra all
127137` ` `
128138
129139# # Tests
@@ -132,8 +142,7 @@ Tests are run with *pytest*. If you are not familiar with this package, you can
132142
133143To run the tests, from the project directory, simply run:
134144
135- pip install --use-pep517 -r requirements/dev.txt
136- pytest
145+ uv run pytest
137146
138147You should see output similar to:
139148
You can’t perform that action at this time.
0 commit comments