Hopiu/dj-database-url
1
0
Fork 0
mirror of https://github.com/jazzband/dj-database-url.git synced 2026-03-16 22:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #125 from giovanism/long_desc

Browse source 
Set long_description to README.rst
This commit is contained in:
Jacob Kaplan-Moss 2019-12-25 10:53:32 -05:00 committed by GitHub
commit 1937ed9e61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
setup.py
View file

@ -1,62 +1,9 @@
# -*- 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
with open('README.rst') as readme_rst:
readme = readme_rst.read()
setup(
name="dj-database-url",
version="0.5.0",
@ -65,7 +12,7 @@ setup(
author="Kenneth Reitz",
author_email="me@kennethreitz.com",
description="Use Database URLs in your Django Application.",
long_description=__doc__,
long_description=readme,
py_modules=["dj_database_url"],
install_requires=["Django>1.11"],
zip_safe=False,