django-wait-for-db 1.0.1__tar.gz

django_wait_for_db-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fournet Enzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_wait_for_db-1.0.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: django-wait-for-db
+Version: 1.0.1
+Summary: Simple Django app that provides a simple command to wait for the database to be ready before starting the server.
+Home-page: https://github.com/enzofrnt/django_wait_for_db
+Author: enzo_frnt
+Author-email: contact@enzo-frnt.fr
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django
+
+# django_wait_for_db
+ Django app that provides a simple command to wait for the database to be ready before starting the server.
+
+## Usage
+
+Add `django_wait_for_db` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'wait_for_db',
+    ...
+]
+```
+
+Then run the following command:
+
+```bash
+python manage.py wait_for_db
+```
+
+This will wait for the database to be ready before starting the server.
+This is useful when you are using Docker and you want to start the Django server before the database is ready or when you are in an environment where the database is not always available when the Django server starts.
+
+Exemple of a Dockerfile:
+
+```Dockerfile
+FROM python:3.8
+
+(.......)
+
+CMD python manage.py wait_for_db \
+    && python manage.py runserver
+```

django_wait_for_db-1.0.1/README.md

@@ -0,0 +1,34 @@
+# django_wait_for_db
+ Django app that provides a simple command to wait for the database to be ready before starting the server.
+
+## Usage
+
+Add `django_wait_for_db` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'wait_for_db',
+    ...
+]
+```
+
+Then run the following command:
+
+```bash
+python manage.py wait_for_db
+```
+
+This will wait for the database to be ready before starting the server.
+This is useful when you are using Docker and you want to start the Django server before the database is ready or when you are in an environment where the database is not always available when the Django server starts.
+
+Exemple of a Dockerfile:
+
+```Dockerfile
+FROM python:3.8
+
+(.......)
+
+CMD python manage.py wait_for_db \
+    && python manage.py runserver
+```

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: django-wait-for-db
+Version: 1.0.1
+Summary: Simple Django app that provides a simple command to wait for the database to be ready before starting the server.
+Home-page: https://github.com/enzofrnt/django_wait_for_db
+Author: enzo_frnt
+Author-email: contact@enzo-frnt.fr
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django
+
+# django_wait_for_db
+ Django app that provides a simple command to wait for the database to be ready before starting the server.
+
+## Usage
+
+Add `django_wait_for_db` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'wait_for_db',
+    ...
+]
+```
+
+Then run the following command:
+
+```bash
+python manage.py wait_for_db
+```
+
+This will wait for the database to be ready before starting the server.
+This is useful when you are using Docker and you want to start the Django server before the database is ready or when you are in an environment where the database is not always available when the Django server starts.
+
+Exemple of a Dockerfile:
+
+```Dockerfile
+FROM python:3.8
+
+(.......)
+
+CMD python manage.py wait_for_db \
+    && python manage.py runserver
+```

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+setup.py
+django_wait_for_db.egg-info/PKG-INFO
+django_wait_for_db.egg-info/SOURCES.txt
+django_wait_for_db.egg-info/dependency_links.txt
+django_wait_for_db.egg-info/not-zip-safe
+django_wait_for_db.egg-info/requires.txt
+django_wait_for_db.egg-info/top_level.txt
+wait_for_db/__init__.py
+wait_for_db/apps.py
+wait_for_db/management/commands/wait_for_db.py

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/requires.txt

@@ -0,0 +1 @@
+Django

django_wait_for_db-1.0.1/django_wait_for_db.egg-info/top_level.txt

@@ -0,0 +1 @@
+wait_for_db

django_wait_for_db-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_wait_for_db-1.0.1/setup.py

@@ -0,0 +1,41 @@
+import os
+from setuptools import setup
+
+with open(os.path.join(os.path.dirname(__file__), "README.md")) as f:
+    readme = f.read()
+
+setup(
+    name="django-wait-for-db",
+    version="1.0.1",
+    description="Simple Django app that provides a simple command to wait for the database to be ready before starting the server.",
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    author="enzo_frnt",
+    author_email="contact@enzo-frnt.fr",
+    url="https://github.com/enzofrnt/django_wait_for_db",
+    license="MIT",
+    zip_safe=False,
+    packages=[
+        "wait_for_db",
+        "wait_for_db.management",
+        "wait_for_db.management.commands",
+    ],
+    install_requires=[
+        "Django",
+    ],
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Web Environment",
+        "Framework :: Django",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Topic :: Software Development :: Libraries",
+    ],
+)

django_wait_for_db-1.0.1/wait_for_db/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class WaitForDbConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'wait_for_db'

django_wait_for_db-1.0.1/wait_for_db/management/commands/wait_for_db.py

@@ -0,0 +1,24 @@
+import time
+
+from django.db import connections
+from django.db.utils import OperationalError
+from django.core.management.base import BaseCommand
+from django.db import DEFAULT_DB_ALIAS
+from django.conf import settings
+
+
+class Command(BaseCommand):
+    """Django command to pause execution until database is available"""
+
+    def handle(self, *args, **options):
+        """Handle the command"""
+        self.stdout.write('Waiting for database...')
+        while True:
+            try:
+                db_conn = connections[DEFAULT_DB_ALIAS]
+                db_conn.ensure_connection()
+                self.stdout.write(self.style.SUCCESS('Database available!'))
+                break 
+            except OperationalError:
+                self.stdout.write(f'Database unavailable on {settings.DATABASES["default"]["HOST"]}:{settings.DATABASES["default"]["PORT"]}, waiting 1 second...')
+                time.sleep(1)