add readme

Author: cuongnb14

README.md

@@ -0,0 +1,64 @@
+# Django Dynamic Setting
+Django Dynamic Setting is a Django app, designed to help you manage your project settings, storage settings in database, provided admin UI to manage there settings.
+
+# Setup
+```sh
+pip install git+https://github.com/cuongnb14/django-dynamic-setting@master#egg=django-dynamic-setting
+```
+
+Add to install app
+```python
+INSTALLED_APPS = [
+    ...
+    "dynamic_setting",
+    ...
+]
+```
+
+Run migrate
+```python
+python3 manage.py migrate
+```
+
+
+Define setting in your code
+```
+# your_app/setting.py
+from dynamic_setting.base.fields import IntegerSettingField, BooleanSettingField, CharSettingField
+from dynamic_setting.base.settings import Settings
+
+
+class BotSettings(Settings):
+
+    sell_enable = BooleanSettingField(default=1, description='enable sell action')
+    title = CharSettingField(default="hello", is_public=True)
+
+    class Meta:
+        name = 'bot'
+
+# your_app/apps.py
+from django.apps import AppConfig
+from dynamic_setting.settings_registry import settings_registry
+
+from .setting import BotSettings
+
+
+class BotConfig(AppConfig):
+    name = "cg_bot.bot"
+    verbose_name = "Bots"
+
+    def ready(self):
+        settings_registry.register(BotSettings)
+```
+
+Init setting
+```sh
+python3 manage.py init_dynamic_setting
+```
+
+
+Use setting
+```
+setting = BotSettings()
+print(setting.title)
+```

README.rst

@@ -0,0 +1,42 @@
+# Generated by Django 5.1 on 2024-09-09 11:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="DynamicSetting",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("category", models.CharField(max_length=255)),
+                ("name", models.CharField(max_length=255)),
+                ("value", models.TextField(blank=True)),
+                (
+                    "description",
+                    models.CharField(
+                        blank=True, default=None, max_length=1000, null=True
+                    ),
+                ),
+                ("is_public", models.BooleanField(default=False)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("modified_at", models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                "unique_together": {("name", "category")},
+            },
+        ),
+    ]

dynamic_setting/migrations/0001_initial.py

@@ -1,7 +1,7 @@
 from django.core.exceptions import ValidationError
 from django.db import models
 
-class DynamicSetting(TimeStampedModel):
+class DynamicSetting(models.Model):
 
     category = models.CharField(max_length=255)
     name = models.CharField(max_length=255)

dynamic_setting/models.py

@@ -1,7 +1,7 @@
 import os
 from setuptools import find_packages, setup
 
-with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
+with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
     README = readme.read()
 
 # allow setup.py to be run from any path