Skip to content

Commit

Permalink
📝 Extend README
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbal committed Jun 20, 2024
1 parent e4fb24f commit d1a50af
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Features
========

* Bundling shared dependencies and introducing minimum versions for these dependencies
* Providing generic base Django settings to avoid duplicate settings across registration components

Installation
============
Expand All @@ -37,6 +38,24 @@ Install
2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
3. Recompile the dependencies

If you want to reuse the generic base settings, you can do the following:

* Add the following imports to the project's ``base.py`` file:

.. code::python
from open_api_framework.conf.base import * # noqa
from open_api_framework.conf.utils import config
* Then you can initialize sentry by adding the following line to ``base.py``:

.. code::python
init_sentry()
* After that, compare the settings from ``open_api_framework.conf.base`` to the settings defined in the project's
`base.py <open_api_framework/conf/base.py>`_ and remove settings from the latter to make use of the generic settings (if this is desired).

Local development
=================

Expand Down

0 comments on commit d1a50af

Please sign in to comment.