-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
83 changed files
with
6,281 additions
and
2 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
env/Lib/site-packages/dj_database_url-2.1.0.dist-info/INSTALLER
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pip |
27 changes: 27 additions & 0 deletions
27
env/Lib/site-packages/dj_database_url-2.1.0.dist-info/LICENSE
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Copyright (c) Kenneth Reitz & individual contributors | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without modification, | ||
are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, | ||
this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright | ||
notice, this list of conditions and the following disclaimer in the | ||
documentation and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of Django nor the names of its contributors may be used | ||
to endorse or promote products derived from this software without | ||
specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | ||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | ||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
258 changes: 258 additions & 0 deletions
258
env/Lib/site-packages/dj_database_url-2.1.0.dist-info/METADATA
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,258 @@ | ||
Metadata-Version: 2.1 | ||
Name: dj-database-url | ||
Version: 2.1.0 | ||
Summary: Use Database URLs in your Django Application. | ||
Home-page: https://github.com/jazzband/dj-database-url | ||
Author: Original Author: Kenneth Reitz, Maintained by: JazzBand Community | ||
License: BSD | ||
Project-URL: GitHub, https://github.com/jazzband/dj-database-url/ | ||
Project-URL: Release log, https://github.com/jazzband/dj-database-url/blob/master/CHANGELOG.md | ||
Platform: any | ||
Classifier: Environment :: Web Environment | ||
Classifier: Framework :: Django | ||
Classifier: Framework :: Django :: 3.2 | ||
Classifier: Framework :: Django :: 4.0 | ||
Classifier: Framework :: Django :: 4.1 | ||
Classifier: Intended Audience :: Developers | ||
Classifier: License :: OSI Approved :: BSD License | ||
Classifier: Operating System :: OS Independent | ||
Classifier: Programming Language :: Python | ||
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content | ||
Classifier: Topic :: Software Development :: Libraries :: Python Modules | ||
Classifier: Programming Language :: Python | ||
Classifier: Programming Language :: Python :: 3 | ||
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 | ||
Description-Content-Type: text/x-rst | ||
License-File: LICENSE | ||
Requires-Dist: Django >=3.2 | ||
Requires-Dist: typing-extensions >=3.10.0.0 | ||
|
||
DJ-Database-URL | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. image:: https://jazzband.co/static/img/badge.png | ||
:target: https://jazzband.co/ | ||
:alt: Jazzband | ||
|
||
.. image:: https://github.com/jazzband/dj-database-url/actions/workflows/test.yml/badge.svg | ||
:target: https://github.com/jazzband/dj-database-url/actions/workflows/test.yml | ||
|
||
.. image:: https://codecov.io/gh/jazzband/dj-database-url/branch/master/graph/badge.svg?token=7srBUpszOa | ||
:target: https://codecov.io/gh/jazzband/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), Redshift, CockroachDB, Timescale, Timescale (GIS) and SQLite. | ||
|
||
Installation | ||
------------ | ||
|
||
Installation is simple: | ||
|
||
.. code-block:: console | ||
|
||
$ pip install dj-database-url | ||
|
||
Usage | ||
----- | ||
|
||
1. If ``DATABASES`` is already defined: | ||
|
||
- Configure your database in ``settings.py`` from ``DATABASE_URL``: | ||
|
||
.. code-block:: python | ||
|
||
import dj_database_url | ||
|
||
DATABASES['default'] = dj_database_url.config( | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
) | ||
|
||
- Provide a default: | ||
|
||
.. code-block:: python | ||
|
||
DATABASES['default'] = dj_database_url.config( | ||
default='postgres://...', | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
) | ||
|
||
- Parse an arbitrary Database URL: | ||
|
||
.. code-block:: python | ||
|
||
DATABASES['default'] = dj_database_url.parse( | ||
'postgres://...', | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
) | ||
|
||
2. If ``DATABASES`` is not defined: | ||
|
||
- Configure your database in ``settings.py`` from ``DATABASE_URL``: | ||
|
||
.. code-block:: python | ||
|
||
import dj_database_url | ||
|
||
DATABASES = { | ||
'default': dj_database_url.config( | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
), | ||
} | ||
|
||
- You can provide a default, used if the ``DATABASE_URL`` setting is not defined: | ||
|
||
.. code-block:: python | ||
|
||
DATABASES = { | ||
'default': dj_database_url.config( | ||
default='postgres://...', | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
) | ||
} | ||
|
||
- Parse an arbitrary Database URL: | ||
|
||
.. code-block:: python | ||
|
||
DATABASES = { | ||
'default': dj_database_url.parse( | ||
'postgres://...', | ||
conn_max_age=600, | ||
conn_health_checks=True, | ||
) | ||
} | ||
|
||
``conn_max_age`` sets the |CONN_MAX_AGE setting|__, which tells Django to | ||
persist database connections between requests, up to the given lifetime in | ||
seconds. If you do not provide a value, it will follow Django’s default of | ||
``0``. Setting it is recommended for performance. | ||
|
||
.. |CONN_MAX_AGE setting| replace:: ``CONN_MAX_AGE`` setting | ||
__ https://docs.djangoproject.com/en/stable/ref/settings/#conn-max-age | ||
|
||
``conn_health_checks`` sets the |CONN_HEALTH_CHECKS setting|__ (new in Django | ||
4.1), which tells Django to check a persisted connection still works at the | ||
start of each request. If you do not provide a value, it will follow Django’s | ||
default of ``False``. Enabling it is recommended if you set a non-zero | ||
``conn_max_age``. | ||
|
||
.. |CONN_HEALTH_CHECKS setting| replace:: ``CONN_HEALTH_CHECKS`` setting | ||
__ https://docs.djangoproject.com/en/stable/ref/settings/#conn-health-checks | ||
|
||
Strings passed to `dj_database_url` must be valid URLs; in | ||
particular, special characters must be url-encoded. The following url will raise | ||
a `ValueError`: | ||
|
||
.. code-block:: plaintext | ||
|
||
postgres://user:p#ssword!@localhost/foobar | ||
|
||
and should instead be passed as: | ||
|
||
.. code-block:: plaintext | ||
|
||
postgres://user:p%23ssword!@localhost/foobar | ||
|
||
`TEST <https://docs.djangoproject.com/en/stable/ref/settings/#test>`_ settings can be configured using the ``test_options`` attribute:: | ||
|
||
DATABASES['default'] = dj_database_url.config(default='postgres://...', test_options={'NAME': 'mytestdatabase'}) | ||
|
||
|
||
URL schema | ||
---------- | ||
|
||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Engine | Django Backend | URL | | ||
+======================+===============================================+==================================================+ | ||
| PostgreSQL | ``django.db.backends.postgresql`` [1]_ | ``postgres://USER:PASSWORD@HOST:PORT/NAME`` [2]_ | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| PostGIS | ``django.contrib.gis.db.backends.postgis`` | ``postgis://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| MSSQL | ``sql_server.pyodbc`` | ``mssql://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| MSSQL [5]_ | ``mssql`` | ``mssqlms://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| MySQL | ``django.db.backends.mysql`` | ``mysql://USER:PASSWORD@HOST:PORT/NAME`` [2]_ | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| MySQL (GIS) | ``django.contrib.gis.db.backends.mysql`` | ``mysqlgis://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| SQLite | ``django.db.backends.sqlite3`` | ``sqlite:///PATH`` [3]_ | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| SpatiaLite | ``django.contrib.gis.db.backends.spatialite`` | ``spatialite:///PATH`` [3]_ | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Oracle | ``django.db.backends.oracle`` | ``oracle://USER:PASSWORD@HOST:PORT/NAME`` [4]_ | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Oracle (GIS) | ``django.contrib.gis.db.backends.oracle`` | ``oraclegis://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Redshift | ``django_redshift_backend`` | ``redshift://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| CockroachDB | ``django_cockroachdb`` | ``cockroach://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Timescale [6]_ | ``timescale.db.backends.postgresql`` | ``timescale://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
| Timescale (GIS) [6]_ | ``timescale.db.backend.postgis`` | ``timescalegis://USER:PASSWORD@HOST:PORT/NAME`` | | ||
+----------------------+-----------------------------------------------+--------------------------------------------------+ | ||
|
||
.. [1] The django.db.backends.postgresql backend is named django.db.backends.postgresql_psycopg2 in older releases. For | ||
backwards compatibility, the old name still works in newer versions. (The new name does not work in older versions). | ||
.. [2] With PostgreSQL or CloudSQL, you can also use unix domain socket paths with | ||
`percent encoding <http://www.postgresql.org/docs/9.2/interactive/libpq-connect.html#AEN38162>`_: | ||
``postgres://%2Fvar%2Flib%2Fpostgresql/dbname`` | ||
``mysql://uf07k1i6d8ia0v@%2fcloudsql%2fproject%3alocation%3ainstance/dbname`` | ||
.. [3] SQLite connects to file based databases. The same URL format is used, omitting | ||
the hostname, and using the "file" portion as the filename of the database. | ||
This has the effect of four slashes being present for an absolute file path: | ||
``sqlite:////full/path/to/your/database/file.sqlite``. | ||
.. [4] Note that when connecting to Oracle the URL isn't in the form you may know | ||
from using other Oracle tools (like SQLPlus) i.e. user and password are separated | ||
by ``:`` not by ``/``. Also you can omit ``HOST`` and ``PORT`` | ||
and provide a full DSN string or TNS name in ``NAME`` part. | ||
.. [5] Microsoft official `mssql-django <https://github.com/microsoft/mssql-django>`_ adapter. | ||
.. [6] Using the django-timescaledb Package which must be installed. | ||
|
||
|
||
Contributing | ||
------------ | ||
|
||
We welcome contributions to this project. Projects can take two forms: | ||
|
||
1. Raising issues or helping others through the github issue tracker. | ||
2. Contributing code. | ||
|
||
Raising Issues or helping others: | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
When submitting an issue or helping other remember you are talking to humans who have feelings, jobs and lives of their | ||
own. Be nice, be kind, be polite. Remember english may not be someone first language, if you do not understand or | ||
something is not clear be polite and re-ask/ re-word. | ||
|
||
Contributing code: | ||
^^^^^^^^^^^^^^^^^^ | ||
|
||
* Before writing code be sure to check existing PR's and issues in the tracker. | ||
* Write code to the pylint spec. | ||
* Large or wide sweeping changes will take longer, and may face more scrutiny than smaller confined changes. | ||
* Code should be pass `black` and `flake8` validation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
dj_database_url-2.1.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 | ||
dj_database_url-2.1.0.dist-info/LICENSE,sha256=Emnu_QhkmoP1ncOPx7yFY8X0C41EkjQXLoOg8NYSFLg,1536 | ||
dj_database_url-2.1.0.dist-info/METADATA,sha256=S-IEqq8vCfnEEB6RrNxq-Df5qf9-WiOlkPptWt1R0RU,11920 | ||
dj_database_url-2.1.0.dist-info/RECORD,, | ||
dj_database_url-2.1.0.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92 | ||
dj_database_url-2.1.0.dist-info/top_level.txt,sha256=pntpOZz98RuKrz2758NE7pVfM4EG6zO_0IBiYUrqS94,16 | ||
dj_database_url/__init__.py,sha256=pxuX2rCsPjjjY0p82kqJz6Izuzt1Awa5bsJ7FHZ8iqE,5716 | ||
dj_database_url/__pycache__/__init__.cpython-312.pyc,, | ||
dj_database_url/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Wheel-Version: 1.0 | ||
Generator: bdist_wheel (0.41.1) | ||
Root-Is-Purelib: true | ||
Tag: py3-none-any | ||
|
1 change: 1 addition & 0 deletions
1
env/Lib/site-packages/dj_database_url-2.1.0.dist-info/top_level.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dj_database_url |
Oops, something went wrong.