django-testcontainers-plus 0.1.0__tar.gz

django_testcontainers_plus-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

django_testcontainers_plus-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

django_testcontainers_plus-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andrew Woodward
+
+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_testcontainers_plus-0.1.0/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: django-testcontainers-plus
+Version: 0.1.0
+Summary: A plug-and-play testcontainers integration for Django - supports databases, Redis, MinIO, and more
+Project-URL: Homepage, https://github.com/arwoodward/django-testcontainers-plus
+Project-URL: Repository, https://github.com/arwoodward/django-testcontainers-plus
+Project-URL: Documentation, https://github.com/arwoodward/django-testcontainers-plus#readme
+Project-URL: Issues, https://github.com/arwoodward/django-testcontainers-plus/issues
+Author-email: Andrew Woodward <arwoodward553@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: containers,django,docker,mysql,postgres,redis,testcontainers,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: django>=4.2
+Requires-Dist: testcontainers>=4.0.0
+Provides-Extra: all
+Provides-Extra: dev
+Requires-Dist: django-stubs>=4.2.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-django>=4.5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: mongodb
+Provides-Extra: mysql
+Provides-Extra: postgres
+Provides-Extra: redis
+Description-Content-Type: text/markdown
+
+# Django Testcontainers Plus
+
+A plug-and-play testcontainers integration for Django
+
+[![PyPI version](https://badge.fury.io/py/django-testcontainers-plus.svg)](https://badge.fury.io/py/django-testcontainers-plus)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Why Django Testcontainers Plus?
+
+Testing Django applications often requires external services like PostgreSQL, Redis, or S3. Django Testcontainers Plus makes this effortless by:
+
+- **Zero Configuration**: Automatically detects your database and service needs from Django settings
+- **Plug and Play**: Install, add to settings, and go - no manual container management
+- **Database Agnostic**: Supports PostgreSQL, MySQL, MariaDB, MongoDB, and more
+- **Beyond Databases**: Redis for caching, MinIO for S3, and other services
+- **Dual Compatibility**: Works with both Django's test runner and pytest
+- **Smart Defaults**: Sensible defaults with full customization when needed
+
+## Installation
+
+```bash
+# Using uv (recommended)
+uv add django-testcontainers-plus
+
+# Using pip
+pip install django-testcontainers-plus
+```
+
+## Quick Start
+
+### Option 1: Django Test Runner (Minimal Setup)
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'myapp',
+    }
+}
+```
+
+That's it! Run your tests:
+
+```bash
+python manage.py test
+```
+
+PostgreSQL will automatically start in a container, run your tests, and clean up.
+
+### Option 2: pytest-django
+
+```python
+# conftest.py
+pytest_plugins = ['django_testcontainers_plus.pytest_plugin']
+```
+
+```python
+# settings.py
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'test',
+    }
+}
+```
+
+Run your tests:
+
+```bash
+pytest
+```
+
+## Supported Services
+
+### Databases
+- PostgreSQL - Auto-detected from `django.db.backends.postgresql`
+- MySQL/MariaDB - Auto-detected from `django.db.backends.mysql`
+- MongoDB - Coming soon
+- SQL Server - Coming soon
+
+### Other Services
+- Redis - Auto-detected from cache/Celery settings
+- MinIO - S3-compatible storage (coming soon)
+- Mailhog - Email testing (coming soon)
+- Elasticsearch - Search (coming soon)
+
+## Configuration
+
+### Zero Configuration (Auto-Detection)
+
+Django Testcontainers Plus automatically detects services from your settings:
+
+```python
+# PostgreSQL auto-detected
+DATABASES = {
+    'default': {'ENGINE': 'django.db.backends.postgresql', 'NAME': 'test'}
+}
+
+# Redis auto-detected
+CACHES = {
+    'default': {'BACKEND': 'django.core.cache.backends.redis.RedisCache'}
+}
+
+# Celery Redis auto-detected
+CELERY_BROKER_URL = 'redis://localhost:6379/0'
+```
+
+### Custom Configuration
+
+Override defaults when needed:
+
+```python
+TESTCONTAINERS = {
+    'postgres': {
+        'image': 'postgres:16-alpine',
+        'username': 'testuser',
+        'password': 'testpass',
+        'dbname': 'testdb',
+    },
+    'redis': {
+        'image': 'redis:7-alpine',
+    },
+}
+```
+
+### Disable Auto-Detection
+
+```python
+TESTCONTAINERS = {
+    'postgres': {
+        'auto': False,  # Disable auto-detection
+        'enabled': True,  # But explicitly enable it
+    },
+}
+```
+
+## Examples
+
+### PostgreSQL with Django Test Runner
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'myapp',
+    }
+}
+
+# Optional: Customize PostgreSQL version
+TESTCONTAINERS = {
+    'postgres': {
+        'image': 'postgres:15',
+    }
+}
+```
+
+```bash
+python manage.py test
+```
+
+### MySQL with pytest
+
+```python
+# conftest.py
+pytest_plugins = ['django_testcontainers_plus.pytest_plugin']
+
+# settings.py
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.mysql',
+        'NAME': 'test',
+    }
+}
+```
+
+```bash
+pytest
+```
+
+### PostgreSQL + Redis
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'test',
+    }
+}
+
+CACHES = {
+    'default': {
+        'BACKEND': 'django.core.cache.backends.redis.RedisCache',
+        'LOCATION': 'redis://localhost:6379/0',
+    }
+}
+```
+
+Both PostgreSQL and Redis containers will start automatically!
+
+## How It Works
+
+1. **Detection**: Scans your Django settings for database engines and service backends
+2. **Configuration**: Merges detected needs with any custom `TESTCONTAINERS` config
+3. **Startup**: Starts necessary containers before tests run
+4. **Injection**: Updates Django settings with container connection details
+5. **Cleanup**: Stops and removes containers after tests complete
+
+## Development
+
+This project uses [uv](https://github.com/astral-sh/uv) for package management.
+
+```bash
+# Clone the repository
+git clone https://github.com/arwoodward/django-testcontainers-plus
+cd django-testcontainers-plus
+
+# Install dependencies
+uv sync --dev
+
+# Run tests
+uv run pytest
+
+# Run linting
+uv run ruff check .
+
+# Run type checking
+uv run mypy src/
+```
+
+## Roadmap
+
+- [x] PostgreSQL support
+- [x] MySQL/MariaDB support
+- [x] Redis support
+- [x] Django test runner integration
+- [x] pytest plugin
+- [ ] MongoDB support
+- [ ] MinIO (S3) support
+- [ ] Mailhog support
+- [ ] Elasticsearch support
+- [ ] RabbitMQ support
+- [ ] Container reuse between test runs
+- [ ] Parallel test support
+- [ ] Full documentation site
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Credits
+
+Inspired by [django-rdtwt](https://github.com/wonkybream/django-rdtwt) but with broader service support and active maintenance.
+
+Built with [testcontainers-python](https://github.com/testcontainers/testcontainers-python).

django_testcontainers_plus-0.1.0/README.md

@@ -0,0 +1,267 @@
+# Django Testcontainers Plus
+
+A plug-and-play testcontainers integration for Django
+
+[![PyPI version](https://badge.fury.io/py/django-testcontainers-plus.svg)](https://badge.fury.io/py/django-testcontainers-plus)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Why Django Testcontainers Plus?
+
+Testing Django applications often requires external services like PostgreSQL, Redis, or S3. Django Testcontainers Plus makes this effortless by:
+
+- **Zero Configuration**: Automatically detects your database and service needs from Django settings
+- **Plug and Play**: Install, add to settings, and go - no manual container management
+- **Database Agnostic**: Supports PostgreSQL, MySQL, MariaDB, MongoDB, and more
+- **Beyond Databases**: Redis for caching, MinIO for S3, and other services
+- **Dual Compatibility**: Works with both Django's test runner and pytest
+- **Smart Defaults**: Sensible defaults with full customization when needed
+
+## Installation
+
+```bash
+# Using uv (recommended)
+uv add django-testcontainers-plus
+
+# Using pip
+pip install django-testcontainers-plus
+```
+
+## Quick Start
+
+### Option 1: Django Test Runner (Minimal Setup)
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'myapp',
+    }
+}
+```
+
+That's it! Run your tests:
+
+```bash
+python manage.py test
+```
+
+PostgreSQL will automatically start in a container, run your tests, and clean up.
+
+### Option 2: pytest-django
+
+```python
+# conftest.py
+pytest_plugins = ['django_testcontainers_plus.pytest_plugin']
+```
+
+```python
+# settings.py
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'test',
+    }
+}
+```
+
+Run your tests:
+
+```bash
+pytest
+```
+
+## Supported Services
+
+### Databases
+- PostgreSQL - Auto-detected from `django.db.backends.postgresql`
+- MySQL/MariaDB - Auto-detected from `django.db.backends.mysql`
+- MongoDB - Coming soon
+- SQL Server - Coming soon
+
+### Other Services
+- Redis - Auto-detected from cache/Celery settings
+- MinIO - S3-compatible storage (coming soon)
+- Mailhog - Email testing (coming soon)
+- Elasticsearch - Search (coming soon)
+
+## Configuration
+
+### Zero Configuration (Auto-Detection)
+
+Django Testcontainers Plus automatically detects services from your settings:
+
+```python
+# PostgreSQL auto-detected
+DATABASES = {
+    'default': {'ENGINE': 'django.db.backends.postgresql', 'NAME': 'test'}
+}
+
+# Redis auto-detected
+CACHES = {
+    'default': {'BACKEND': 'django.core.cache.backends.redis.RedisCache'}
+}
+
+# Celery Redis auto-detected
+CELERY_BROKER_URL = 'redis://localhost:6379/0'
+```
+
+### Custom Configuration
+
+Override defaults when needed:
+
+```python
+TESTCONTAINERS = {
+    'postgres': {
+        'image': 'postgres:16-alpine',
+        'username': 'testuser',
+        'password': 'testpass',
+        'dbname': 'testdb',
+    },
+    'redis': {
+        'image': 'redis:7-alpine',
+    },
+}
+```
+
+### Disable Auto-Detection
+
+```python
+TESTCONTAINERS = {
+    'postgres': {
+        'auto': False,  # Disable auto-detection
+        'enabled': True,  # But explicitly enable it
+    },
+}
+```
+
+## Examples
+
+### PostgreSQL with Django Test Runner
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'myapp',
+    }
+}
+
+# Optional: Customize PostgreSQL version
+TESTCONTAINERS = {
+    'postgres': {
+        'image': 'postgres:15',
+    }
+}
+```
+
+```bash
+python manage.py test
+```
+
+### MySQL with pytest
+
+```python
+# conftest.py
+pytest_plugins = ['django_testcontainers_plus.pytest_plugin']
+
+# settings.py
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.mysql',
+        'NAME': 'test',
+    }
+}
+```
+
+```bash
+pytest
+```
+
+### PostgreSQL + Redis
+
+```python
+# settings.py
+TEST_RUNNER = 'django_testcontainers_plus.runner.TestcontainersRunner'
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'test',
+    }
+}
+
+CACHES = {
+    'default': {
+        'BACKEND': 'django.core.cache.backends.redis.RedisCache',
+        'LOCATION': 'redis://localhost:6379/0',
+    }
+}
+```
+
+Both PostgreSQL and Redis containers will start automatically!
+
+## How It Works
+
+1. **Detection**: Scans your Django settings for database engines and service backends
+2. **Configuration**: Merges detected needs with any custom `TESTCONTAINERS` config
+3. **Startup**: Starts necessary containers before tests run
+4. **Injection**: Updates Django settings with container connection details
+5. **Cleanup**: Stops and removes containers after tests complete
+
+## Development
+
+This project uses [uv](https://github.com/astral-sh/uv) for package management.
+
+```bash
+# Clone the repository
+git clone https://github.com/arwoodward/django-testcontainers-plus
+cd django-testcontainers-plus
+
+# Install dependencies
+uv sync --dev
+
+# Run tests
+uv run pytest
+
+# Run linting
+uv run ruff check .
+
+# Run type checking
+uv run mypy src/
+```
+
+## Roadmap
+
+- [x] PostgreSQL support
+- [x] MySQL/MariaDB support
+- [x] Redis support
+- [x] Django test runner integration
+- [x] pytest plugin
+- [ ] MongoDB support
+- [ ] MinIO (S3) support
+- [ ] Mailhog support
+- [ ] Elasticsearch support
+- [ ] RabbitMQ support
+- [ ] Container reuse between test runs
+- [ ] Parallel test support
+- [ ] Full documentation site
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Credits
+
+Inspired by [django-rdtwt](https://github.com/wonkybream/django-rdtwt) but with broader service support and active maintenance.
+
+Built with [testcontainers-python](https://github.com/testcontainers/testcontainers-python).

django_testcontainers_plus-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "django-testcontainers-plus"
+version = "0.1.0"
+description = "A plug-and-play testcontainers integration for Django - supports databases, Redis, MinIO, and more"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [
+    { name = "Andrew Woodward", email = "arwoodward553@gmail.com" }
+]
+requires-python = ">=3.10"
+keywords = ["django", "testcontainers", "testing", "docker", "containers", "postgres", "mysql", "redis"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "django>=4.2",
+    "testcontainers>=4.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-django>=4.5.0",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.8.0",
+    "mypy>=1.8.0",
+    "django-stubs>=4.2.0",
+]
+postgres = []
+mysql = []
+redis = []
+mongodb = []
+all = []
+
+[project.urls]
+Homepage = "https://github.com/arwoodward/django-testcontainers-plus"
+Repository = "https://github.com/arwoodward/django-testcontainers-plus"
+Documentation = "https://github.com/arwoodward/django-testcontainers-plus#readme"
+Issues = "https://github.com/arwoodward/django-testcontainers-plus/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "B", "C4", "PT"]
+ignore = []
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+plugins = ["mypy_django_plugin.main"]
+
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+python_files = ["test_*.py", "*_test.py"]
+addopts = [
+    "--cov=django_testcontainers_plus",
+    "--cov-report=term-missing",
+    "--cov-report=html",
+]

django_testcontainers_plus-0.1.0/src/django_testcontainers_plus/__init__.py

@@ -0,0 +1,16 @@
+"""Django Testcontainers Plus - Plug-and-play testcontainers for Django."""
+
+from .manager import ContainerManager
+from .providers import ContainerProvider, MySQLProvider, PostgresProvider, RedisProvider
+from .runner import TestcontainersRunner
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ContainerManager",
+    "ContainerProvider",
+    "PostgresProvider",
+    "MySQLProvider",
+    "RedisProvider",
+    "TestcontainersRunner",
+]