diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..5dc9bcf --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,11 @@ +========= +Changelog +========= + +0.1.0 (2024-03-21) +================== + +First release. Features: + +* ``setup_configuration`` management command +* ``BaseConfigurationStep`` base class. \ No newline at end of file diff --git a/README.rst b/README.rst index 15f4744..b41e330 100644 --- a/README.rst +++ b/README.rst @@ -5,14 +5,14 @@ Welcome to django_setup_configuration's documentation! :Version: 0.1.0 :Source: https://github.com/maykinmedia/django-setup-configuration -:Keywords: ```` +:Keywords: Configuration :PythonVersion: 3.10 |build-status| |code-quality| |black| |coverage| |docs| |python-versions| |django-versions| |pypi-version| - +Manage your configuration via django command. .. contents:: @@ -21,8 +21,7 @@ Welcome to django_setup_configuration's documentation! Features ======== -* ... -* ... +* management command, which runs the ordered list of all configuration steps Installation ============ @@ -31,26 +30,36 @@ Requirements ------------ * Python 3.10 or above -* Django 4.2 or newer +* Django 3.2 or newer Install ------- +1. Install from PyPI + .. code-block:: bash pip install django-setup-configuration +2. Add ``django_setup_configuration`` to the ``INSTALLED_APPS`` setting. + Usage ===== - +1. Create configurations steps based on ``BaseConfigurationStep`` class. + +2. Specify these steps in ``SETUP_CONFIGURATION_STEPS`` setting. + +3. Run ``setup_configuration`` management command manually or put it in the init container + during deployment. + Local development ================= -To install and develop the library locally, use:: +To install and develop the library locally, use: .. code-block:: bash