Metadata-Version: 2.1
Name: django-db-seed
Version: 0.1
Summary: A Django app to backup and restore the database.
Home-page: https://github.com/AfzalSabbir/django_db_seed
Author: Afzalur Rahman Sabbir
Author-email: afzalbd1@gmail.com
License: MIT
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: Django>=5.0.3

# Django DB Seed

Django DB Seed is a Django package designed to simplify the process of seeding your database with initial data. It provides a convenient way to define and load seed data into your Django project.

## Installation

You can install Django DB Seed using pip:

```bash
pip install django-db-seed
```

## Configuration

To configure Django DB Seed, you can define the following settings in your Django project's settings file (`settings.py`):

```python
# settings.py

# ...
from django.conf import settings
# ...

DJANGO_DB_SEED = {
    'seed_dir': f"{settings.BASE_DIR}/db-seed/",
    'apps': [
        "admin",
        "auth",
    ]
}
```

- `seed_dir`: Specifies the directory where your seed data files are located. By default, it is set to a directory named `db-seed` in your project's base directory (`BASE_DIR`).
- `apps`: Specifies the Django apps for which you want to load seed data. You can specify one or more app names in a list.

## Usage

Once configured, you can use Django DB Seed to manage your database seed data.

### Backup Database Seed Data

To backup the seed data in your files, run the following management command:

```bash
python manage.py db-seed --mode=backup
```

### Restore Database Seed Data

To restore the seed data in your database from backup, run the following management command:

```bash
python manage.py db-seed --mode=restore
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
