https://github.com/dex4er/django-database-for-apps

Django router for apps with more than 1 database
https://github.com/dex4er/django-database-for-apps

Last synced: 10 days ago
JSON representation

Django router for apps with more than 1 database

• Host: GitHub
• URL: https://github.com/dex4er/django-database-for-apps
• Owner: dex4er
• License: lgpl-3.0
• Created: 2019-04-15T10:36:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-23T09:57:46.000Z (over 5 years ago)
• Last Synced: 2024-11-28T06:48:44.950Z (28 days ago)
• Language: Python
• Size: 27.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/pypi/v/django-database-for-apps.svg

   :target: https://pypi.python.org/pypi/django-database-for-apps

.. image:: https://travis-ci.org/dex4er/django-database-for-apps.svg?branch=master

   :target: https://travis-ci.org/dex4er/django-database-for-apps

.. image:: https://readthedocs.org/projects/django-database-for-apps/badge/?version=latest

   :target: http://django-database-for-apps.readthedocs.org/en/latest/

.. image:: https://img.shields.io/pypi/pyversions/django-database-for-apps.svg

   :target: https://www.python.org/

.. image:: https://img.shields.io/pypi/djversions/django-database-for-apps.svg

   :target: https://www.djangoproject.com/

django-database-for-apps

========================

``django-database-for-apps`` is a package that provides a router which chooses

a database based on app name.

Installation

------------

Install with ``pip`` or ``pipenv``:

.. code:: python

  pip install django-database-for-apps

Add ``django_database_for_apps`` to your installed apps in your

settings.py file:

.. code:: python

  INSTALLED_APPS = [

      'django_database_for_apps',

      ...

  ]

Configure DB routers:

.. code:: python

  DATABASE_ROUTERS = [

      'django_database_for_apps.Router'

  ]

Configuration

-------------

.. code:: python

  # list of apps and theirs database

  DATABASE_FOR_APPS = {

      'test_project': 'default',

      '*': 'django',

  }

``*`` matches all applications so the default database might be redefined from

``'default'`` to something else.

Optional

^^^^^^^^

.. code:: python

  # allows relations between databases (default: None)

  DATABASE_FOR_APPS_RELATIONS = True

Documentation

-------------

See http://django-database-for-apps.readthedocs.org/

License

-------

Copyright © 2019, Piotr Roszatycki

This software is distributed under the GNU Lesser General Public License (LGPL

3 or greater).