Metadata-Version: 2.1
Name: django-auth-db-router
Version: 1.2.0
Summary: Simple database router was originally written for personal and work purposes.
Home-page: https://github.com/HarleyK1ng/django-auth-db-router
Author: Astafeev Rustam
Author-email: astafeev0308@gmail.com
License: BSD-3-Clause
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Django auth DB router.

Simple database router that helps to split your main database and authentication database.
This may be necessary, for example, when splitting a project into microservices.

## Quickstart

1. Add `django_auth_db_router` to your `INSTALLED_APPS` setting like this:
    ```
    INSTALLED_APPS = [
        ...
        'django_auth_db_router',
        ...
    ]
    ```

2. Add `DATABASE_ROUTERS` setting in `settings.py` file:
    ```
    DATABASE_ROUTERS = [
        'django_auth_db_router.routers.AuthRouter',
    ]
    ```
   
3. Add `auth_db` section to `DATABASES`:
   ```
   DATABASES = {
       'default': {
           'ENGINE': 'django.db.backends.sqlite3',
           'NAME': BASE_DIR / 'default.sqlite3',
       },
       'auth_db': {
           'ENGINE': 'django.db.backends.sqlite3',
           'NAME': BASE_DIR / 'auth.sqlite3',
       },
   }
    ```

4. Finally, add `AUTH_DB` setting:
   ```
   DATABASES = {
       'default': {
           'ENGINE': 'django.db.backends.sqlite3',
           'NAME': BASE_DIR / 'default.sqlite3',
       },
       'auth_db': {
           'ENGINE': 'django.db.backends.sqlite3',
           'NAME': BASE_DIR / 'auth.sqlite3',
       },
   }
   
   AUTH_DB = 'auth_db'
   ```
   
   Without this setting router will use `default` db connection.
