mirror of
https://github.com/jazzband/dj-database-url.git
synced 2026-03-16 22:20:24 +00:00
94 lines
3 KiB
Python
94 lines
3 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
dj-database-url
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. image:: https://secure.travis-ci.org/kennethreitz/dj-database-url.png?branch=master
|
|
:target: http://travis-ci.org/kennethreitz/dj-database-url
|
|
|
|
This simple Django utility allows you to utilize the
|
|
`12factor <http://www.12factor.net/backing-services>`_ inspired
|
|
``DATABASE_URL`` environment variable to configure your Django application.
|
|
|
|
The ``dj_database_url.config`` method returns a Django database connection
|
|
dictionary, populated with all the data specified in your URL. There is
|
|
also a `conn_max_age` argument to easily enable Django's connection pool.
|
|
|
|
If you'd rather not use an environment variable, you can pass a URL in directly
|
|
instead to ``dj_database_url.parse``.
|
|
|
|
Supported Databases
|
|
-------------------
|
|
|
|
Support currently exists for PostgreSQL, PostGIS, MySQL, MySQL (GIS),
|
|
Oracle, Oracle (GIS), and SQLite.
|
|
|
|
Installation
|
|
------------
|
|
|
|
Installation is simple::
|
|
|
|
$ pip install dj-database-url
|
|
|
|
Usage
|
|
-----
|
|
|
|
Configure your database in ``settings.py`` from ``DATABASE_URL``::
|
|
|
|
import dj_database_url
|
|
|
|
DATABASES['default'] = dj_database_url.config(conn_max_age=600, ssl_require=True)
|
|
|
|
Provide a default::
|
|
|
|
DATABASES['default'] = dj_database_url.config(default='postgres://...'}
|
|
|
|
Parse an arbitrary Database URL::
|
|
|
|
DATABASES['default'] = dj_database_url.parse('postgres://...', conn_max_age=600)
|
|
|
|
The ``conn_max_age`` attribute is the lifetime of a database connection in seconds
|
|
and is available in Django 1.6+. If you do not set a value, it will default to ``0``
|
|
which is Django's historical behavior of using a new database connection on each
|
|
request. Use ``None`` for unlimited persistent connections.
|
|
|
|
|
|
"""
|
|
|
|
from setuptools import setup
|
|
|
|
setup(
|
|
name='dj-database-url',
|
|
version='0.5.0',
|
|
url='https://github.com/kennethreitz/dj-database-url',
|
|
license='BSD',
|
|
author='Kenneth Reitz',
|
|
author_email='me@kennethreitz.com',
|
|
description='Use Database URLs in your Django Application.',
|
|
long_description=__doc__,
|
|
py_modules=['dj_database_url'],
|
|
zip_safe=False,
|
|
include_package_data=True,
|
|
platforms='any',
|
|
classifiers=[
|
|
'Environment :: Web Environment',
|
|
'Framework :: Django',
|
|
'Framework :: Django :: 1.11',
|
|
'Framework :: Django :: 2.0',
|
|
'Framework :: Django :: 2.1',
|
|
'Framework :: Django :: 2.2',
|
|
'Intended Audience :: Developers',
|
|
'License :: OSI Approved :: BSD License',
|
|
'Operating System :: OS Independent',
|
|
'Programming Language :: Python',
|
|
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
|
|
'Topic :: Software Development :: Libraries :: Python Modules',
|
|
'Programming Language :: Python',
|
|
'Programming Language :: Python :: 2.7',
|
|
'Programming Language :: Python :: 3',
|
|
'Programming Language :: Python :: 3.4',
|
|
'Programming Language :: Python :: 3.5',
|
|
'Programming Language :: Python :: 3.6',
|
|
'Programming Language :: Python :: 3.7',
|
|
]
|
|
)
|