|
30 | 30 | .. _enumerations: https://docs.python.org/3/library/enum.html#enum.Enum
|
31 | 31 | .. _ValueError: https://docs.python.org/3/library/exceptions.html#ValueError
|
32 | 32 | .. _DRY: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself
|
33 |
| -.. _DRF: https://www.django-rest-framework.org |
34 | 33 |
|
35 | 34 | Django Enum
|
36 | 35 | ###########
|
@@ -175,22 +174,25 @@ Installation
|
175 | 174 |
|
176 | 175 | pip install django-enum
|
177 | 176 |
|
178 |
| -.. note:: |
179 |
| - |
180 |
| - ``django-enum`` *does not* need to be added to ``INSTALLED_APPS``. |
181 |
| - |
182 | 177 | .. note::
|
183 | 178 |
|
184 | 179 | ``django-enum`` has several optional dependencies that are not pulled in
|
185 | 180 | by default. ``EnumFields`` work seamlessly with all Django apps that
|
186 |
| - work with model fields with choices. Optional integrations are provided |
187 |
| - with several popular libraries to extend this basic functionality. To |
188 |
| - utilize the `enum-properties <https://pypi.org/project/enum-properties/>`_ |
189 |
| - choice types you must `pip install enum-properties` and to use the |
190 |
| - ``EnumFilter`` type for |
191 |
| - `django-filter <https://pypi.org/project/django-filter/>`_ you |
192 |
| - must `pip install django-filter`. And to use the DRF_ serializer field you |
193 |
| - must `pip install djangorestframework`. |
| 181 | + work with model fields with choices without any additional work. Optional |
| 182 | + integrations are provided with several popular libraries to extend this |
| 183 | + basic functionality. |
| 184 | + |
| 185 | +Integrations are provided that leverage |
| 186 | +`enum-properties <https://pypi.org/project/enum-properties/>`_ to make |
| 187 | +enumerations do more work and to provide extended functionality for |
| 188 | +`django-filter <https://pypi.org/project/django-filter/>`_ and |
| 189 | +`djangorestframework <https://www.django-rest-framework.org>`_. |
| 190 | + |
| 191 | +.. code:: bash |
| 192 | +
|
| 193 | + pip install enum-properties |
| 194 | + pip install django-filter |
| 195 | + pip install djangorestframework |
194 | 196 |
|
195 | 197 | If features are utilized that require a missing optional dependency an
|
196 | 198 | exception will be thrown.
|
0 commit comments